diff --git a/.circleci/config.yml b/.circleci/config.yml
index 913d3b6d40f..9f7fec1ebb9 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -234,6 +234,21 @@ jobs:
- test_optional:
py: "39_pandas_2"
+ # No numpy
+ python_312_no_numpy:
+ docker:
+ - image: cimg/python:3.12-browsers
+ steps:
+ - run:
+ name: Check that numpy is not installed
+ command: |
+ if pip list | grep numpy > /dev/null 2>&1
+ then exit 1
+ else exit 0
+ fi
+ - test_optional:
+ py: "312_no_numpy"
+
# Orca
python_38_orca:
docker:
@@ -385,6 +400,8 @@ jobs:
- run:
name: Create conda environment
command: |
+ conda config --remove channels defaults
+ conda config --add channels conda-forge
conda create -n env --yes python=3.9 conda-build=3.28.4 conda-verify
conda install -n env -c conda-forge jupyterlab=3 nodejs=16
conda init bash
@@ -598,5 +615,6 @@ workflows:
- python_39_pandas_2_optional
- python_38_orca
- python_39_percy
+ - python_312_no_numpy
- build-doc
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 20c880922af..36afac98a67 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,19 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).
+## [5.24.0] - 2024-08-29
+
+### Added
+- New `px` functions for maps: `scatter_map`, `line_map`, `choropleth_map`, and `density_map`.
+
+### Updated
+
+- Updated Plotly.js from version 2.34.0 to version 2.35.0. See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#2350----2024-08-29) for more information. These changes are reflected in the auto-generated `plotly.graph_objects` module. Notable changes include:
+ - Add new traces: scattermap, choroplethmap and densitymap and map subplots which use maplibre to render maps [[#7015](https://github.com/plotly/plotly.js/pull/7015), [#7060](https://github.com/plotly/plotly.js/pull/7060), [#7085](https://github.com/plotly/plotly.js/pull/7085), [#7088](https://github.com/plotly/plotly.js/pull/7088), [#7090](https://github.com/plotly/plotly.js/pull/7090), [#7092](https://github.com/plotly/plotly.js/pull/7092), [#7094](https://github.com/plotly/plotly.js/pull/7094), [#7134](https://github.com/plotly/plotly.js/pull/7134)]
+ - Deprecate mapbox traces and mapbox subplot [[#7087](https://github.com/plotly/plotly.js/pull/7087)]
+
+- Fixed a bug in integer validation of arrays that threw an error when an array contained a mix of strings and integers.
+
## [5.23.0] - 2024-07-23
### Updated
diff --git a/README.md b/README.md
index d8039732b70..f5d176602d8 100644
--- a/README.md
+++ b/README.md
@@ -40,7 +40,7 @@
## Quickstart
-`pip install plotly==5.23.0`
+`pip install plotly==5.24.0`
Inside [Jupyter](https://jupyter.org/install) (installable with `pip install "jupyterlab>=3" "ipywidgets>=7.6"`):
@@ -85,13 +85,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==5.23.0
+pip install plotly==5.24.0
```
or conda.
```
-conda install -c plotly plotly=5.23.0
+conda install -c plotly plotly=5.24.0
```
### JupyterLab Support
@@ -113,7 +113,7 @@ The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**,
```
# JupyterLab 2.x renderer support
-jupyter labextension install jupyterlab-plotly@5.23.0 @jupyter-widgets/jupyterlab-manager
+jupyter labextension install jupyterlab-plotly@5.24.0 @jupyter-widgets/jupyterlab-manager
```
Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.
diff --git a/binder/requirements.txt b/binder/requirements.txt
index 9ef2fa447fd..ef2a082ddd4 100644
--- a/binder/requirements.txt
+++ b/binder/requirements.txt
@@ -1,5 +1,5 @@
jupytext
-plotly==5.23.0
+plotly==5.24.0
jupyter
notebook
pandas==2.2.2
diff --git a/doc/apidoc/conf.py b/doc/apidoc/conf.py
index e6f7542bd02..d5978b7ce63 100644
--- a/doc/apidoc/conf.py
+++ b/doc/apidoc/conf.py
@@ -26,7 +26,7 @@
# The short X.Y version
version = ""
# The full version, including alpha/beta/rc tags
-release = "5.23.0"
+release = "5.24.0"
# -- General configuration ---------------------------------------------------
diff --git a/doc/apidoc/plotly.express.rst b/doc/apidoc/plotly.express.rst
index 5f687e54868..c2512ee82d5 100644
--- a/doc/apidoc/plotly.express.rst
+++ b/doc/apidoc/plotly.express.rst
@@ -18,12 +18,14 @@ plotly's high-level API for rapid figure generation. ::
scatter_3d
scatter_polar
scatter_ternary
+ scatter_map
scatter_mapbox
scatter_geo
line
line_3d
line_polar
line_ternary
+ line_map
line_mapbox
line_geo
area
@@ -45,9 +47,11 @@ plotly's high-level API for rapid figure generation. ::
parallel_coordinates
parallel_categories
choropleth
+ choropleth_map
choropleth_mapbox
density_contour
density_heatmap
+ density_map
density_mapbox
imshow
set_mapbox_access_token
diff --git a/doc/python/axes.md b/doc/python/axes.md
index 2ade3a47213..851fb142db8 100644
--- a/doc/python/axes.md
+++ b/doc/python/axes.md
@@ -41,7 +41,7 @@ Other kinds of subplots and axes are described in other tutorials:
- [Polar axes](/python/polar-chart/). The axis object is [`go.layout.Polar`](/python/reference/layout/polar/)
- [Ternary axes](/python/ternary-plots). The axis object is [`go.layout.Ternary`](/python/reference/layout/ternary/)
- [Geo axes](/python/map-configuration/). The axis object is [`go.layout.Geo`](/python/reference/layout/geo/)
-- [Mapbox axes](/python/mapbox-layers/). The axis object is [`go.layout.Mapbox`](/python/reference/layout/mapbox/)
+- [Map axes](/python/tile-map-layers/). The axis object is [`go.layout.Map`](/python/reference/layout/map/)
- [Color axes](/python/colorscales/). The axis object is [`go.layout.Coloraxis`](/python/reference/layout/coloraxis/).
**See also** the tutorials on [facet plots](/python/facet-plots/), [subplots](/python/subplots) and [multiple axes](/python/multiple-axes/).
diff --git a/doc/python/bubble-maps.md b/doc/python/bubble-maps.md
index 23e1d543824..3315e934d90 100644
--- a/doc/python/bubble-maps.md
+++ b/doc/python/bubble-maps.md
@@ -5,10 +5,10 @@ jupyter:
text_representation:
extension: .md
format_name: markdown
- format_version: '1.1'
- jupytext_version: 1.1.1
+ format_version: '1.3'
+ jupytext_version: 1.16.3
kernelspec:
- display_name: Python 3
+ display_name: Python 3 (ipykernel)
language: python
name: python3
language_info:
@@ -20,14 +20,14 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.6.7
+ version: 3.10.0
plotly:
description: How to make bubble maps in Python with Plotly.
display_as: maps
language: python
layout: base
name: Bubble Maps
- order: 4
+ order: 5
page_type: example_index
permalink: python/bubble-maps/
thumbnail: thumbnail/bubble-map.jpg
diff --git a/doc/python/choropleth-maps.md b/doc/python/choropleth-maps.md
index 8bd82fc225b..6cdf73d51e0 100644
--- a/doc/python/choropleth-maps.md
+++ b/doc/python/choropleth-maps.md
@@ -6,9 +6,9 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.3'
- jupytext_version: 1.14.1
+ jupytext_version: 1.16.3
kernelspec:
- display_name: Python 3
+ display_name: Python 3 (ipykernel)
language: python
name: python3
language_info:
@@ -20,20 +20,20 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.8.8
+ version: 3.10.0
plotly:
description: How to make choropleth maps in Python with Plotly.
display_as: maps
language: python
layout: base
name: Choropleth Maps
- order: 7
+ order: 8
page_type: u-guide
permalink: python/choropleth-maps/
thumbnail: thumbnail/choropleth.jpg
---
-A [Choropleth Map](https://en.wikipedia.org/wiki/Choropleth_map) is a map composed of colored polygons. It is used to represent spatial variations of a quantity. This page documents how to build **outline** choropleth maps, but you can also build [choropleth **tile maps** using our Mapbox trace types](/python/mapbox-county-choropleth).
+A [Choropleth Map](https://en.wikipedia.org/wiki/Choropleth_map) is a map composed of colored polygons. It is used to represent spatial variations of a quantity. This page documents how to build **outline** choropleth maps, but you can also build [choropleth **tile maps**](/python/tile-county-choropleth).
Below we show how to create Choropleth Maps using either Plotly Express' `px.choropleth` function or the lower-level `go.Choropleth` graph object.
diff --git a/doc/python/county-choropleth.md b/doc/python/county-choropleth.md
index 1340b4a75ad..935f3f649e0 100644
--- a/doc/python/county-choropleth.md
+++ b/doc/python/county-choropleth.md
@@ -5,10 +5,10 @@ jupyter:
text_representation:
extension: .md
format_name: markdown
- format_version: '1.2'
- jupytext_version: 1.3.1
+ format_version: '1.3'
+ jupytext_version: 1.16.3
kernelspec:
- display_name: Python 3
+ display_name: Python 3 (ipykernel)
language: python
name: python3
language_info:
@@ -20,7 +20,7 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.6.8
+ version: 3.10.0
plotly:
description: How to create colormaped representations of USA counties by FIPS
values in Python.
@@ -28,7 +28,7 @@ jupyter:
language: python
layout: base
name: USA County Choropleth Maps
- order: 10
+ order: 11
page_type: u-guide
permalink: python/county-choropleth/
thumbnail: thumbnail/county-choropleth-usa-greybkgd.jpg
@@ -37,7 +37,7 @@ jupyter:
### Deprecation warning
-This page describes a [legacy "figure factory" method](/python/figure-factories/) for creating map-like figures using [self-filled scatter traces](/python/shapes). **This is no longer the recommended way to make county-level choropleth maps**, instead we recommend using a [GeoJSON-based approach to making outline choropleth maps](/python/choropleth-maps/) or the alternative [Mapbox tile-based choropleth maps](/python/mapbox-county-choropleth).
+This page describes a [legacy "figure factory" method](/python/figure-factories/) for creating map-like figures using [self-filled scatter traces](/python/shapes). **This is no longer the recommended way to make county-level choropleth maps**, instead we recommend using a [GeoJSON-based approach to making outline choropleth maps](/python/choropleth-maps/) or the alternative [tile-based choropleth maps](/python/tile-county-choropleth).
#### Required Packages
@@ -274,7 +274,7 @@ fig.layout.template = None
fig.show()
```
-Also see Mapbox county choropleths made in Python: [https://plotly.com/python/mapbox-county-choropleth/](https://plotly.com/python/mapbox-county-choropleth/)
+Also see tile county choropleths made in Python: [https://plotly.com/python/tile-county-choropleth/](https://plotly.com/python/tile-county-choropleth/)
### Reference
diff --git a/doc/python/datashader.md b/doc/python/datashader.md
index 1c8d08852f7..ba1ec46e4fe 100644
--- a/doc/python/datashader.md
+++ b/doc/python/datashader.md
@@ -5,10 +5,10 @@ jupyter:
text_representation:
extension: .md
format_name: markdown
- format_version: '1.2'
- jupytext_version: 1.3.0
+ format_version: '1.3'
+ jupytext_version: 1.16.3
kernelspec:
- display_name: Python 3
+ display_name: Python 3 (ipykernel)
language: python
name: python3
language_info:
@@ -20,7 +20,7 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.7.3
+ version: 3.10.0
plotly:
description: How to use datashader to rasterize large datasets, and visualize
the generated raster data with plotly.
@@ -36,10 +36,10 @@ jupyter:
[datashader](https://datashader.org/) creates rasterized representations of large datasets for easier visualization, with a pipeline approach consisting of several steps: projecting the data on a regular grid, creating a color representation of the grid, etc.
-### Passing datashader rasters as a mapbox image layer
+### Passing datashader rasters as a tile map image layer
We visualize here the spatial distribution of taxi rides in New York City. A higher density
-is observed on major avenues. For more details about mapbox charts, see [the mapbox layers tutorial](/python/mapbox-layers). No mapbox token is needed here.
+is observed on major avenues. For more details about tile-based maps, see [the tile map layers tutorial](/python/tile-map-layers).
```python
import pandas as pd
@@ -51,7 +51,7 @@ cvs = ds.Canvas(plot_width=1000, plot_height=1000)
agg = cvs.points(dff, x='Lon', y='Lat')
# agg is an xarray object, see http://xarray.pydata.org/en/stable/ for more details
coords_lat, coords_lon = agg.coords['Lat'].values, agg.coords['Lon'].values
-# Corners of the image, which need to be passed to mapbox
+# Corners of the image
coordinates = [[coords_lon[0], coords_lat[0]],
[coords_lon[-1], coords_lat[0]],
[coords_lon[-1], coords_lat[-1]],
@@ -62,16 +62,12 @@ import datashader.transfer_functions as tf
img = tf.shade(agg, cmap=fire)[::-1].to_pil()
import plotly.express as px
-# Trick to create rapidly a figure with mapbox axes
-fig = px.scatter_mapbox(dff[:1], lat='Lat', lon='Lon', zoom=12)
-# Add the datashader image as a mapbox layer image
-fig.update_layout(mapbox_style="carto-darkmatter",
- mapbox_layers = [
- {
- "sourcetype": "image",
- "source": img,
- "coordinates": coordinates
- }]
+# Trick to create rapidly a figure with map axes
+fig = px.scatter_map(dff[:1], lat='Lat', lon='Lon', zoom=12)
+# Add the datashader image as a tile map layer image
+fig.update_layout(
+ map_style="carto-darkmatter",
+ map_layers=[{"sourcetype": "image", "source": img, "coordinates": coordinates}],
)
fig.show()
```
@@ -113,7 +109,3 @@ fig.update_traces(hoverongaps=False)
fig.update_layout(coloraxis_colorbar=dict(title='Count', tickprefix='1.e'))
fig.show()
```
-
-```python
-
-```
\ No newline at end of file
diff --git a/doc/python/figure-structure.md b/doc/python/figure-structure.md
index 7a078a05c94..f55abad91b5 100644
--- a/doc/python/figure-structure.md
+++ b/doc/python/figure-structure.md
@@ -97,7 +97,7 @@ The second of the three top-level attributes of a figure is `layout`, whose valu
* Subplots of various types on which can be drawn multiple traces and which are positioned in paper coordinates:
* `xaxis`, `yaxis`, `xaxis2`, `yaxis3` etc: X and Y cartesian axes, the intersections of which are cartesian subplots
* `scene`, `scene2`, `scene3` etc: 3d scene subplots
- * `ternary`, `ternary2`, `ternary3`, `polar`, `polar2`, `polar3`, `geo`, `geo2`, `geo3`, `mapbox`, `mapbox2`, `mabox3`, `smith`, `smith2` etc: ternary, polar, geo, mapbox or smith subplots
+ * `ternary`, `ternary2`, `ternary3`, `polar`, `polar2`, `polar3`, `geo`, `geo2`, `geo3`, `map`, `map2`, `map3`, `smith`, `smith2` etc: ternary, polar, geo, map or smith subplots
* Non-data marks which can be positioned in paper coordinates, or in data coordinates linked to 2d cartesian subplots:
* `annotations`: [textual annotations with or without arrows](/python/text-and-annotations/)
* `shapes`: [lines, rectangles, ellipses or open or closed paths](/python/shapes/)
@@ -181,18 +181,18 @@ The following trace types are compatible with smith subplots via the `smith` att
### Map Trace Types and Subplots
-Figures can include two different types of map subplots: [geo subplots for outline maps](/python/map-configuration/) and [mapbox subplots for tile maps](/python/mapbox-layers/). The following trace types support attributes named `geo` or `mapbox`, whose values must refer to corresponding objects in the layout i.e. `geo="geo2"` etc. Note that attributes such as `layout.geo2` and `layout.mapbox` etc do not have to be explicitly defined, in which case default values will be inferred. Multiple traces of a compatible type can be placed on the same subplot.
+Figures can include two different types of map subplots: [geo subplots for outline maps](/python/map-configuration/) and [tile-based maps](/python/tile-map-layers/). The following trace types support attributes named `geo` or `map`, whose values must refer to corresponding objects in the layout i.e. `geo="geo2"` etc. Note that attributes such as `layout.geo2` and `layout.map` etc do not have to be explicitly defined, in which case default values will be inferred. Multiple traces of a compatible type can be placed on the same subplot.
The following trace types are compatible with geo subplots via the `geo` attribute:
* [`scattergeo`](/python/scatter-plots-on-maps/), which can be used to draw [individual markers](/python/scatter-plots-on-maps/), [line and curves](/python/lines-on-maps/) and filled areas on outline maps
* [`choropleth`](/python/choropleth-maps/): [colored polygons](/python/choropleth-maps/) on outline maps
-The following trace types are compatible with mapbox subplots via the `mapbox` attribute:
+The following trace types are compatible with tile map subplots via the `map` attribute:
-* [`scattermapbox`](/python/scattermapbox/), which can be used to draw [individual markers](/python/scattermapbox/), [lines and curves](/python/lines-on-mapbox/) and [filled areas](/python/filled-area-on-mapbox/) on tile maps
-* [`choroplethmapbox`](/python/mapbox-county-choropleth/): colored polygons on tile maps
-* [`densitymapbox`](/python/mapbox-density-heatmaps/): density heatmaps on tile maps
+* [`scattermap`](/python/tile-scatter-maps/), which can be used to draw [individual markers](/python/tile-scatter-maps/), [lines and curves](/python/lines-on-tile-maps/) and [filled areas](/python/filled-area-tile-maps/) on tile maps
+* [`choroplethmap`](/python/tile-county-choropleth/): colored polygons on tile maps
+* [`densitymap`](/python/tile-density-heatmaps/): density heatmaps on tile maps
### Traces Which Are Their Own Subplots
diff --git a/doc/python/filled-area-on-mapbox.md b/doc/python/filled-area-on-mapbox.md
index 2cd389642ae..8e0af02484b 100644
--- a/doc/python/filled-area-on-mapbox.md
+++ b/doc/python/filled-area-on-mapbox.md
@@ -5,10 +5,10 @@ jupyter:
text_representation:
extension: .md
format_name: markdown
- format_version: '1.1'
- jupytext_version: 1.1.1
+ format_version: '1.3'
+ jupytext_version: 1.16.3
kernelspec:
- display_name: Python 3
+ display_name: Python 3 (ipykernel)
language: python
name: python3
language_info:
@@ -20,68 +20,63 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.6.8
+ version: 3.10.0
plotly:
- description: How to make an area on Map in Python with Plotly.
+ description: How to make an area on tile-based maps in Python with Plotly.
display_as: maps
language: python
layout: base
- name: Filled Area on Maps
- order: 3
+ name: Filled Area on Tile Maps
+ order: 4
page_type: example_index
- permalink: python/filled-area-on-mapbox/
+ permalink: python/filled-area-tile-maps/
+ redirect_from: python/filled-area-on-mapbox/
thumbnail: thumbnail/area.jpg
---
-
-
-### Mapbox Access Token and Base Map Configuration
-
-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.
+There are three different ways to show a filled area on a tile-based map:
-There are three different ways to show a filled area in a Mapbox map:
+- Using a [Scattermap](https://plotly.com/python/reference/scattermap/) trace and setting the `fill` attribute to 'toself'
+- Using a map layout (i.e. by minimally using an empty [Scattermap](https://plotly.com/python/reference/scattermap/) trace) and adding a GeoJSON layer
+- Using the [Choroplethmap](https://plotly.com/python/tile-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 `Scattermap` Trace
-### Filled `Scattermapbox` Trace
-
-The following example uses `Scattermapbox` and sets `fill = 'toself'`
+The following example uses `Scattermap` and sets `fill = 'toself'`
```python
import plotly.graph_objects as go
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
fill = "toself",
lon = [-74, -70, -70, -74], lat = [47, 47, 45, 45],
marker = { 'size': 10, 'color': "orange" }))
fig.update_layout(
- mapbox = {
+ map = {
'style': "open-street-map",
'center': {'lon': -73, 'lat': 46 },
'zoom': 5},
showlegend = False)
fig.show()
+
```
-### Multiple Filled Areas with a `Scattermapbox` trace
+### Multiple Filled Areas with a `Scattermap` 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://plotly.com/python/reference/scattermapbox/#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/scattermap/#scattermap-connectgaps) attribute.
```python
import plotly.graph_objects as go
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
mode = "lines", fill = "toself",
lon = [-10, -10, 8, 8, -10, None, 30, 30, 50, 50, 30, None, 100, 100, 80, 80, 100],
lat = [30, 6, 6, 30, 30, None, 20, 30, 30, 20, 20, None, 40, 50, 50, 40, 40]))
fig.update_layout(
- mapbox = {'style': "open-street-map", 'center': {'lon': 30, 'lat': 30}, 'zoom': 2},
+ map = {'style': "open-street-map", 'center': {'lon': 30, 'lat': 30}, 'zoom': 2},
showlegend = False,
margin = {'l':0, 'r':0, 'b':0, 't':0})
@@ -95,13 +90,13 @@ In this map we add a GeoJSON layer.
```python
import plotly.graph_objects as go
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
mode = "markers",
lon = [-73.605], lat = [45.51],
marker = {'size': 20, 'color': ["cyan"]}))
fig.update_layout(
- mapbox = {
+ map = {
'style': "open-street-map",
'center': { 'lon': -73.6, 'lat': 45.5},
'zoom': 12, 'layers': [{
@@ -139,6 +134,36 @@ fig.update_layout(
fig.show()
```
+
+### Mapbox Maps
+
+> Mapbox traces are deprecated and may be removed in a future version of Plotly.py.
+
+The earlier examples using `go.Scattermap` use [Maplibre](https://maplibre.org/maplibre-gl-js/docs/) for rendering. This trace was introduced in Plotly.py 5.24 and is now the recommended way to draw filled areas on tile-based maps. There is also a trace that uses [Mapbox](https://docs.mapbox.com), called `go.Scattermapbox`.
+
+To use the `Scattermapbox` trace type, in some cases 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.
+
+Here's one of the earlier examples rewritten to use `Scattermapbox`.
+
+```python
+import plotly.graph_objects as go
+
+fig = go.Figure(go.Scattermapbox(
+ fill = "toself",
+ lon = [-74, -70, -70, -74], lat = [47, 47, 45, 45],
+ marker = { 'size': 10, 'color': "orange" }))
+
+fig.update_layout(
+ mapbox = {
+ 'style': "open-street-map",
+ 'center': {'lon': -73, 'lat': 46 },
+ 'zoom': 5},
+ showlegend = False)
+
+fig.show()
+```
+
+
#### Reference
-See https://plotly.com/python/reference/scattermapbox/ for more information about mapbox and their attribute options.
\ No newline at end of file
+See https://plotly.com/python/reference/scattermap/ for available attribute options, or for `go.Scattermapbox`, see https://plotly.com/python/reference/scattermapbox/.
diff --git a/doc/python/getting-started.md b/doc/python/getting-started.md
index 0aa23dd37f8..e0909f4b99a 100644
--- a/doc/python/getting-started.md
+++ b/doc/python/getting-started.md
@@ -58,13 +58,13 @@ We also encourage you to join the [Plotly Community Forum](http://community.plot
`plotly` may be installed using `pip`:
```
-$ pip install plotly==5.23.0
+$ pip install plotly==5.24.0
```
or `conda`:
```
-$ conda install -c plotly plotly=5.23.0
+$ conda install -c plotly plotly=5.24.0
```
This package contains everything you need to write figures to standalone HTML files.
@@ -152,7 +152,7 @@ The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**,
```
# JupyterLab 2.x renderer support
-jupyter labextension install jupyterlab-plotly@5.23.0 @jupyter-widgets/jupyterlab-manager
+jupyter labextension install jupyterlab-plotly@5.24.0 @jupyter-widgets/jupyterlab-manager
```
Please check out our [Troubleshooting guide](/python/troubleshooting/) if you run into any problems with JupyterLab, particularly if you are using multiple python environments inside Jupyter.
diff --git a/doc/python/heatmaps.md b/doc/python/heatmaps.md
index 07edd31e9c7..d9079ea2845 100644
--- a/doc/python/heatmaps.md
+++ b/doc/python/heatmaps.md
@@ -34,7 +34,7 @@ jupyter:
thumbnail: thumbnail/heatmap.jpg
---
-The term "heatmap" usually refers to a cartesian plot with data visualized as colored rectangular tiles, which is the subject of this page. It is also sometimes used to refer to [actual maps with density data displayed as color intensity](/python/mapbox-density-heatmaps/).
+The term "heatmap" usually refers to a Cartesian plot with data visualized as colored rectangular tiles, which is the subject of this page. It is also sometimes used to refer to [actual maps with density data displayed as color intensity](/python/tile-density-heatmaps/).
Plotly supports two different types of colored-tile heatmaps:
diff --git a/doc/python/hexbin-mapbox.md b/doc/python/hexbin-mapbox.md
index 74739e856eb..ed30f329774 100644
--- a/doc/python/hexbin-mapbox.md
+++ b/doc/python/hexbin-mapbox.md
@@ -27,7 +27,7 @@ jupyter:
language: python
layout: base
name: Hexbin Mapbox
- order: 13
+ order: 14
page_type: u-guide
permalink: python/hexbin-mapbox/
thumbnail: thumbnail/hexbin_mapbox.jpg
diff --git a/doc/python/hover-text-and-formatting.md b/doc/python/hover-text-and-formatting.md
index 50befc860f0..3dc4249e158 100644
--- a/doc/python/hover-text-and-formatting.md
+++ b/doc/python/hover-text-and-formatting.md
@@ -285,7 +285,7 @@ fig.show()
### Specifying the formatting and labeling of custom fields in a Plotly Express figure using a hovertemplate
-This example adds custom fields to a Plotly Express figure using the custom_data parameter and then adds a hover template that applies d3 formats to each element of the customdata[n] array and uses HTML to customize the fonts and spacing.
+This example adds custom fields to a Plotly Express figure using the `custom_data` parameter and then adds a hover template that applies d3 formats to each element of the `customdata[n]` array and uses HTML to customize the fonts and spacing.
```python
# %%
@@ -301,20 +301,20 @@ df = df.sort_values(['continent', 'country'])
df.rename(columns={"gdpPercap":'GDP per capita', "lifeExp":'Life Expectancy (years)'}, inplace=True)
-fig=px.scatter(df,
+fig=px.scatter(df,
x='GDP per capita',
- y='Life Expectancy (years)',
- color='continent',
- size=np.sqrt(df['pop']),
+ y='Life Expectancy (years)',
+ color='continent',
+ size=np.sqrt(df['pop']),
# Specifying data to make available to the hovertemplate
# The px custom_data parameter has an underscore, while the analogous graph objects customdata parameter has no underscore.
# The px custom_data parameter is a list of column names in the data frame, while the graph objects customdata parameter expects a data frame or a numpy array.
- custom_data=['country', 'continent', 'pop'],
+ custom_data=['country', 'continent', 'pop'],
)
# Plotly express does not have a hovertemplate parameter in the graph creation function, so we apply the template with update_traces
fig.update_traces(
- hovertemplate =
+ hovertemplate =
"%{customdata[0]}
" +
"%{customdata[1]}
" +
"GDP per Capita: %{x:$,.0f}
" +
@@ -371,7 +371,7 @@ fig.show()
### Advanced Hover Template
-This produces the same graphic as in "Specifying the formatting and labeling of custom fields in a Plotly Express figure using a hovertemplate" above, but does so with the `customdata` and `text` parameters of `graph_objects`. It shows how to specify columns from a dataframe to include in the customdata array using the df[["col_i", "col_j"]] subsetting notation. It then references those variables using e.g. %{customdata[0]} in the hovertemplate. It includes comments about major differences between the parameters used by `graph_objects` and `plotly.express`.
+This produces the same graphic as in "Specifying the formatting and labeling of custom fields in a Plotly Express figure using a hovertemplate" above, but does so with the `customdata` and `text` parameters of `graph_objects`. It shows how to specify columns from a dataframe to include in the `customdata` array using the `df[["col_i", "col_j"]]` subsetting notation. It then references those variables using e.g. `%{customdata[0]}` in the hovertemplate. It includes comments about major differences between the parameters used by `graph_objects` and `plotly.express`.
```python
import plotly.graph_objects as go
@@ -404,12 +404,12 @@ for continent_name, df in continent_data.items():
name=continent_name,
# The next three parameters specify the hover text
- # Text supports just one customized field per trace
- # and is implemented here with text=df['continent'],
- # Custom data supports multiple fields through numeric indices in the hovertemplate
- # In we weren't using the text parameter in our example,
+ # Text supports just one customized field per trace
+ # and is implemented here with text=df['continent'],
+ # Custom data supports multiple fields through numeric indices in the hovertemplate
+ # In we weren't using the text parameter in our example,
# we could instead add continent as a third customdata field.
- customdata=df[['country','pop']],
+ customdata=df[['country','pop']],
hovertemplate=
"%{customdata[0]}
" +
"%{text}
" +
@@ -462,14 +462,12 @@ fig.update_layout(title_text='Hover to see the value of z1, z2 and z3 together')
fig.show()
```
-### Setting the Hover Template in Mapbox Maps
+### Setting the Hover Template in Tile Maps
```python
import plotly.graph_objects as go
-token = open(".mapbox_token").read() # you need your own token
-
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
name = "",
mode = "markers+text+lines",
lon = [-75, -80, -50],
@@ -481,8 +479,7 @@ fig = go.Figure(go.Scattermapbox(
"latitude: %{lat}
" ))
fig.update_layout(
- mapbox = {
- 'accesstoken': token,
+ map = {
'style': "outdoors", 'zoom': 1},
showlegend = False)
diff --git a/doc/python/line-charts.md b/doc/python/line-charts.md
index 0c9fe2522a1..4434aa8046c 100644
--- a/doc/python/line-charts.md
+++ b/doc/python/line-charts.md
@@ -77,7 +77,7 @@ IFrame(snippet_url + 'line-charts', width='100%', height=1200)
### Data Order in Line Charts
-Plotly line charts are implemented as [connected scatterplots](https://www.data-to-viz.com/graph/connectedscatter.html) (see below), meaning that the points are plotted and connected with lines **in the order they are provided, with no automatic reordering**.
+Plotly line charts are implemented as [connected scatterplots](https://www.data-to-viz.com/graph/connectedscatter.html) (see below), meaning that the points are plotted and connected with lines **in the order they are provided, with no automatic reordering**.
This makes it possible to make charts like the one below, but also means that it may be required to explicitly sort data before passing it to Plotly to avoid lines moving "backwards" across the chart.
@@ -89,17 +89,17 @@ df = pd.DataFrame(dict(
x = [1, 3, 2, 4],
y = [1, 2, 3, 4]
))
-fig = px.line(df, x="x", y="y", title="Unsorted Input")
+fig = px.line(df, x="x", y="y", title="Unsorted Input")
fig.show()
df = df.sort_values(by="x")
-fig = px.line(df, x="x", y="y", title="Sorted Input")
+fig = px.line(df, x="x", y="y", title="Sorted Input")
fig.show()
```
### Connected Scatterplots
-In a connected scatterplot, two continuous variables are plotted against each other, with a line connecting them in some meaningful order, usually a time variable. In the plot below, we show the "trajectory" of a pair of countries through a space defined by GDP per Capita and Life Expectancy. Botswana's life expectancy
+In a connected scatterplot, two continuous variables are plotted against each other, with a line connecting them in some meaningful order, usually a time variable. In the plot below, we show the "trajectory" of a pair of countries through a space defined by GDP per Capita and Life Expectancy.
```python
import plotly.express as px
@@ -263,7 +263,7 @@ fig.show()
#### Connect Data Gaps
-[connectgaps](https://plotly.com/python/reference/scatter/#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.
+[connectgaps](https://plotly.com/python/reference/scatter/#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-tile-maps/#multiple-filled-areas-with-a-scattermap-trace), we showed how to take benefit of this feature and illustrate multiple areas on a tile map.
```python
import plotly.graph_objects as go
diff --git a/doc/python/lines-on-mapbox.md b/doc/python/lines-on-mapbox.md
index 20bf2fc2726..47e1c57d1e5 100644
--- a/doc/python/lines-on-mapbox.md
+++ b/doc/python/lines-on-mapbox.md
@@ -5,10 +5,10 @@ jupyter:
text_representation:
extension: .md
format_name: markdown
- format_version: '1.2'
- jupytext_version: 1.4.2
+ format_version: '1.3'
+ jupytext_version: 1.16.3
kernelspec:
- display_name: Python 3
+ display_name: Python 3 (ipykernel)
language: python
name: python3
language_info:
@@ -20,26 +20,23 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.7.7
+ version: 3.10.0
plotly:
- description: How to draw a line on Map in Python with Plotly.
+ description: How to draw a line on tile-based maps in Python with Plotly.
display_as: maps
language: python
layout: base
- name: Lines on Mapbox
- order: 2
+ name: Lines on Tile Maps
+ order: 3
page_type: example_index
- permalink: python/lines-on-mapbox/
+ permalink: python/lines-on-tile-maps/
+ redirect_from: python/lines-on-mapbox/
thumbnail: thumbnail/line_mapbox.jpg
---
-### Mapbox Access Token and Base Map Configuration
+### Lines on tile maps using Plotly Express
-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://plotly.com/python-api-reference/generated/plotly.express.line_mapbox.html) 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
+To draw a line on a map, you either can use `px.line_map` in Plotly Express, or `go.Scattermap` in Plotly Graph Objects. Here's an example of drawing a line on a tile-based map using Plotly Express.
```python
import pandas as pd
@@ -49,17 +46,17 @@ us_cities = us_cities.query("State in ['New York', 'Ohio']")
import plotly.express as px
-fig = px.line_mapbox(us_cities, lat="lat", lon="lon", color="State", zoom=3, height=300)
+fig = px.line_map(us_cities, lat="lat", lon="lon", color="State", zoom=3, height=300)
-fig.update_layout(mapbox_style="open-street-map", mapbox_zoom=4, mapbox_center_lat = 41,
+fig.update_layout(map_style="open-street-map", map_zoom=4, map_center_lat = 41,
margin={"r":0,"t":0,"l":0,"b":0})
fig.show()
```
-### Lines on Mapbox maps from GeoPandas
+### Lines on maps from GeoPandas
-Given a GeoPandas geo-data frame with `linestring` or `multilinestring` features, one can extra point data and use `px.line_mapbox()`.
+Given a GeoPandas geo-data frame with `linestring` or `multilinestring` features, one can extra point data and use `px.line_map`.
```python
import plotly.express as px
@@ -94,15 +91,53 @@ for feature, name in zip(geo_df.geometry, geo_df.name):
lons = np.append(lons, None)
names = np.append(names, None)
-fig = px.line_mapbox(lat=lats, lon=lons, hover_name=names,
- mapbox_style="open-street-map", zoom=1)
+fig = px.line_map(lat=lats, lon=lons, hover_name=names,
+ map_style="open-street-map", zoom=1)
+fig.show()
+```
+
+### Lines on maps using `Scattermap` traces
+
+This example uses `go.Scattermap` and sets
+the [mode](https://plotly.com/python/reference/scattermapbox/#scattermap-mode) attribute to a combination of markers and line.
+
+```python
+import plotly.graph_objects as go
+
+fig = go.Figure(go.Scattermap(
+ mode = "markers+lines",
+ lon = [10, 20, 30],
+ lat = [10, 20,30],
+ marker = {'size': 10}))
+
+fig.add_trace(go.Scattermap(
+ mode = "markers+lines",
+ lon = [-50, -60,40],
+ lat = [30, 10, -20],
+ marker = {'size': 10}))
+
+fig.update_layout(
+ margin ={'l':0,'t':0,'b':0,'r':0},
+ map = {
+ 'center': {'lon': 10, 'lat': 10},
+ 'style': "open-street-map",
+ 'center': {'lon': -20, 'lat': -20},
+ 'zoom': 1})
+
fig.show()
```
-### Lines on Mapbox maps using `Scattermapbox` traces
+### Mapbox Maps
+
+> Mapbox traces are deprecated and may be removed in a future version of Plotly.py.
+
+The earlier examples using `px.line_map` and `go.Scattermap` use [Maplibre](https://maplibre.org/maplibre-gl-js/docs/) for rendering. These traces were introduced in Plotly.py 5.24 and are now the recommended way to draw lines on tile-based maps. There are also traces that use [Mapbox](https://docs.mapbox.com): `px.line_mapbox` and `go.Scattermapbox`
-This example uses `go.Scattermapbox` and sets
-the [mode](https://plotly.com/python/reference/scattermapbox/#scattermapbox-mode) attribute to a combination of markers and line.
+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://plotly.com/python-api-reference/generated/plotly.express.line_mapbox.html) 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.
+
+Here's an example of using `Scattermapbox`.
```python
import plotly.graph_objects as go
@@ -132,5 +167,8 @@ fig.show()
#### Reference
-See [function reference for `px.(line_mapbox)`](https://plotly.com/python-api-reference/generated/plotly.express.line_mapbox) or
-https://plotly.com/python/reference/scattermapbox/ for more information about mapbox and their attribute options.
+See [function reference for `px.line_map`](https://plotly.com/python-api-reference/generated/plotly.express.line_map) or
+https://plotly.com/python/reference/scattermap/ for more information about the attributes available.
+
+For Mapbox-based tile maps, see [function reference for `px.line_mapbox`](https://plotly.com/python-api-reference/generated/plotly.express.line_mapbox) or
+https://plotly.com/python/reference/scattermapbox/.
diff --git a/doc/python/lines-on-maps.md b/doc/python/lines-on-maps.md
index 0d8c3bb1bb3..000ec1d0258 100644
--- a/doc/python/lines-on-maps.md
+++ b/doc/python/lines-on-maps.md
@@ -27,7 +27,7 @@ jupyter:
language: python
layout: base
name: Lines on Maps
- order: 6
+ order: 7
page_type: u-guide
permalink: python/lines-on-maps/
thumbnail: thumbnail/flight-paths.jpg
diff --git a/doc/python/map-configuration.md b/doc/python/map-configuration.md
index 6e9f54e4d7e..3f4553b3f7f 100644
--- a/doc/python/map-configuration.md
+++ b/doc/python/map-configuration.md
@@ -6,7 +6,7 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.3'
- jupytext_version: 1.14.7
+ jupytext_version: 1.16.3
kernelspec:
display_name: Python 3 (ipykernel)
language: python
@@ -20,27 +20,32 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.10.4
+ version: 3.10.0
plotly:
- description: How to configure and style base maps for Choropleths and Bubble Maps.
+ description: How to configure and style base maps for outline-based Geo Maps.
display_as: maps
language: python
layout: base
- name: Map Configuration and Styling
- order: 12
+ name: Map Configuration and Styling on Geo Maps
+ order: 13
page_type: u-guide
permalink: python/map-configuration/
thumbnail: thumbnail/county-level-choropleth.jpg
---
-### Mapbox Maps vs Geo Maps
+### Tile Maps vs Outline Maps
Plotly supports two different kinds of maps:
-1. **Mapbox maps** are [tile-based maps](https://en.wikipedia.org/wiki/Tiled_web_map). If your figure is created with a `px.scatter_mapbox`, `px.line_mapbox`, `px.choropleth_mapbox` or `px.density_mapbox` function or otherwise contains one or more traces of type `go.Scattermapbox`, `go.Choroplethmapbox` or `go.Densitymapbox`, the `layout.mapbox` object in your figure contains configuration information for the map itself.
-2. **Geo maps** are outline-based maps. If your figure is created with a `px.scatter_geo`, `px.line_geo` or `px.choropleth` function or otherwise contains one or more traces of type `go.Scattergeo` or `go.Choropleth`, the `layout.geo` object in your figure contains configuration information for the map itself.
+- **[Tile-based maps](https://en.wikipedia.org/wiki/Tiled_web_map)**
-This page documents Geo outline-based maps, and the [Mapbox Layers documentation](/python/mapbox-layers/) describes how to configure Mapbox tile-based maps.
+If your figure is created with a `px.scatter_map`, `px.scatter_mapbox`, `px.line_map`, `px.line_mapbox`, `px.choropleth_map`, `px.choropleth_mapbox`, `px.density_map`, or `px.density_mapbox` function or otherwise contains one or more traces of type `go.Scattermap`, `go.Scattermapbox`, `go.Choroplethmap`, `go.Choroplethmapbox`, `go.Densitymap`, or `go.Densitymapbox`, the `layout.map` object in your figure contains configuration information for the map itself.
+
+- **Outline-based maps**
+
+Geo maps are outline-based maps. If your figure is created with a `px.scatter_geo`, `px.line_geo` or `px.choropleth` function or otherwise contains one or more traces of type `go.Scattergeo` or `go.Choropleth`, the `layout.geo` object in your figure contains configuration information for the map itself.
+
+> This page documents **Geo outline-based maps**, and the [Tile Map Layers documentation](/python/tile-map-layers/) describes how to configure tile-based maps.
**Note:** Plotly Express cannot create empty figures, so the examples below mostly create an "empty" map using `fig = go.Figure(go.Scattergeo())`. That said, every configuration option here is equally applicable to non-empty maps created with the Plotly Express `px.scatter_geo`, `px.line_geo` or `px.choropleth` functions.
diff --git a/doc/python/mapbox-county-choropleth.md b/doc/python/mapbox-county-choropleth.md
index bd439c5e3d2..75b89acb302 100644
--- a/doc/python/mapbox-county-choropleth.md
+++ b/doc/python/mapbox-county-choropleth.md
@@ -6,9 +6,9 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.3'
- jupytext_version: 1.14.1
+ jupytext_version: 1.16.3
kernelspec:
- display_name: Python 3
+ display_name: Python 3 (ipykernel)
language: python
name: python3
language_info:
@@ -20,36 +20,32 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.8.8
+ version: 3.10.0
plotly:
- description: How to make a Mapbox Choropleth Map of US Counties in Python with
- Plotly.
+ description: How to make a choropleth map of US counties in Python with Plotly.
display_as: maps
language: python
layout: base
- name: Mapbox Choropleth Maps
- order: 1
+ name: Tile Choropleth Maps
+ order: 2
page_type: example_index
- permalink: python/mapbox-county-choropleth/
+ permalink: python/tile-county-choropleth/
+ redirect_from: python/mapbox-county-choropleth/
thumbnail: thumbnail/mapbox-choropleth.png
---
-A [Choropleth Map](https://en.wikipedia.org/wiki/Choropleth_map) is a map composed of colored polygons. It is used to represent spatial variations of a quantity. This page documents how to build **tile-map** choropleth maps, but you can also build [**outline** choropleth maps using our non-Mapbox trace types](/python/choropleth-maps).
+A [Choropleth Map](https://en.wikipedia.org/wiki/Choropleth_map) is a map composed of colored polygons. It is used to represent spatial variations of a quantity. This page documents how to build **tile-map** choropleth maps, but you can also build [**outline** choropleth maps](/python/choropleth-maps).
-Below we show how to create Choropleth Maps using either Plotly Express' `px.choropleth_mapbox` function or the lower-level `go.Choroplethmapbox` graph object.
-
-#### Mapbox Access Tokens and Base Map Configuration
-
-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.
+Below we show how to create Choropleth Maps using either Plotly Express' `px.choropleth_map` function or the lower-level `go.Choroplethmap` graph object.
### Introduction: main parameters for choropleth tile maps
-Making choropleth Mapbox maps requires two main types of input:
+Making choropleth maps requires two main types of input:
1. GeoJSON-formatted geometry information where each feature has either an `id` field or some identifying value in `properties`.
2. A list of values indexed by feature identifier.
-The GeoJSON data is passed to the `geojson` argument, and the data is passed into the `color` argument of `px.choropleth_mapbox` (`z` if using `graph_objects`), in the same order as the IDs are passed into the `location` argument.
+The GeoJSON data is passed to the `geojson` argument, and the data is passed into the `color` argument of `px.choropleth_map` (`z` if using `graph_objects`), in the same order as the IDs are passed into the `location` argument.
**Note** the `geojson` attribute can also be the URL to a GeoJSON file, which can speed up map rendering in certain cases.
@@ -77,11 +73,11 @@ df = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/fips-
df.head()
```
-### Choropleth map using plotly.express and carto base map (no token needed)
+### Choropleth map using plotly.express and carto base map
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
-With `px.choropleth_mapbox`, each row of the DataFrame is represented as a region of the choropleth.
+With `px.choropleth_map`, each row of the DataFrame is represented as a region of the choropleth.
```python
from urllib.request import urlopen
@@ -95,10 +91,10 @@ df = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/fips-
import plotly.express as px
-fig = px.choropleth_mapbox(df, geojson=counties, locations='fips', color='unemp',
+fig = px.choropleth_map(df, geojson=counties, locations='fips', color='unemp',
color_continuous_scale="Viridis",
range_color=(0, 12),
- mapbox_style="carto-positron",
+ map_style="carto-positron",
zoom=3, center = {"lat": 37.0902, "lon": -95.7129},
opacity=0.5,
labels={'unemp':'unemployment rate'}
@@ -148,10 +144,10 @@ import plotly.express as px
df = px.data.election()
geojson = px.data.election_geojson()
-fig = px.choropleth_mapbox(df, geojson=geojson, color="Bergeron",
+fig = px.choropleth_map(df, geojson=geojson, color="Bergeron",
locations="district", featureidkey="properties.district",
center={"lat": 45.5517, "lon": -73.7073},
- mapbox_style="carto-positron", zoom=9)
+ map_style="carto-positron", zoom=9)
fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
fig.show()
```
@@ -166,17 +162,17 @@ import plotly.express as px
df = px.data.election()
geojson = px.data.election_geojson()
-fig = px.choropleth_mapbox(df, geojson=geojson, color="winner",
+fig = px.choropleth_map(df, geojson=geojson, color="winner",
locations="district", featureidkey="properties.district",
center={"lat": 45.5517, "lon": -73.7073},
- mapbox_style="carto-positron", zoom=9)
+ map_style="carto-positron", zoom=9)
fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
fig.show()
```
### Using GeoPandas Data Frames
-`px.choropleth_mapbox` accepts the `geometry` of a [GeoPandas](https://geopandas.org/) data frame as the input to `geojson` if the `geometry` contains polygons.
+`px.choropleth_map` accepts the `geometry` of a [GeoPandas](https://geopandas.org/) data frame as the input to `geojson` if the `geometry` contains polygons.
```python
import plotly.express as px
@@ -187,19 +183,19 @@ geo_df = gpd.GeoDataFrame.from_features(
px.data.election_geojson()["features"]
).merge(df, on="district").set_index("district")
-fig = px.choropleth_mapbox(geo_df,
+fig = px.choropleth_map(geo_df,
geojson=geo_df.geometry,
locations=geo_df.index,
color="Joly",
center={"lat": 45.5517, "lon": -73.7073},
- mapbox_style="open-street-map",
+ map_style="open-street-map",
zoom=8.5)
fig.show()
```
-### Choropleth map using plotly.graph_objects and carto base map (no token needed)
+### Choropleth map using plotly.graph_objects and carto base map
-If Plotly Express does not provide a good starting point, it is also possible to use [the more generic `go.Choroplethmapbox` class from `plotly.graph_objects`](/python/graph-objects/).
+If Plotly Express does not provide a good starting point, it is also possible to use [the more generic `go.Choroplethmap` class from `plotly.graph_objects`](/python/graph-objects/).
```python
from urllib.request import urlopen
@@ -213,21 +209,28 @@ df = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/fips-
import plotly.graph_objects as go
-fig = go.Figure(go.Choroplethmapbox(geojson=counties, locations=df.fips, z=df.unemp,
+fig = go.Figure(go.Choroplethmap(geojson=counties, locations=df.fips, z=df.unemp,
colorscale="Viridis", zmin=0, zmax=12,
marker_opacity=0.5, marker_line_width=0))
-fig.update_layout(mapbox_style="carto-positron",
- mapbox_zoom=3, mapbox_center = {"lat": 37.0902, "lon": -95.7129})
+fig.update_layout(map_style="carto-positron",
+ map_zoom=3, map_center = {"lat": 37.0902, "lon": -95.7129})
fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
fig.show()
```
-#### Mapbox Light base map: free token needed
+### Mapbox Maps
+
+> Mapbox traces are deprecated and may be removed in a future version of Plotly.py.
+
+The earlier examples using `px.choropleth_map` and `go.Choroplethmap` use [Maplibre](https://maplibre.org/maplibre-gl-js/docs/) for rendering. These traces were introduced in Plotly.py 5.24 and are now the recommended way to create tile-based choropleth maps. There are also choropleth traces that use [Mapbox](https://docs.mapbox.com): `px.choropleth_mapbox` and `go.Choroplethmapbox`
+
+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.
+
+Here's an exmaple of using the Mapbox Light base map, which requires a free token.
```python
token = open(".mapbox_token").read() # you will need your own token
-
from urllib.request import urlopen
import json
with urlopen('https://raw.githubusercontent.com/plotly/datasets/master/geojson-counties-fips.json') as response:
@@ -249,5 +252,6 @@ fig.show()
#### Reference
-See [function reference for `px.(choropleth_mapbox)`](https://plotly.com/python-api-reference/generated/plotly.express.choropleth_mapbox) or https://plotly.com/python/reference/choroplethmapbox/ for more information about mapbox and their attribute options.
+See [function reference for `px.choropleth_map`](https://plotly.com/python-api-reference/generated/plotly.express.choropleth_map) or https://plotly.com/python/reference/choroplethmap/ for more information about the attributes available.
+For Mapbox-based tile maps, see [function reference for `px.choropleth_mapbox`](https://plotly.com/python-api-reference/generated/plotly.express.choropleth_mapbox) or https://plotly.com/python/reference/choroplethmapbox/.
diff --git a/doc/python/mapbox-density-heatmaps.md b/doc/python/mapbox-density-heatmaps.md
index 85786542536..e694c699437 100644
--- a/doc/python/mapbox-density-heatmaps.md
+++ b/doc/python/mapbox-density-heatmaps.md
@@ -6,7 +6,7 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.3'
- jupytext_version: 1.14.6
+ jupytext_version: 1.16.3
kernelspec:
display_name: Python 3 (ipykernel)
language: python
@@ -20,100 +20,102 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.10.11
+ version: 3.10.0
plotly:
- description: How to make a Mapbox Density Heatmap in Python with Plotly.
+ description: How to make a density heatmap in Python with Plotly.
display_as: maps
language: python
layout: base
- name: Mapbox Density Heatmap
- order: 5
+ name: Density Heatmap
+ order: 6
page_type: u-guide
- permalink: python/mapbox-density-heatmaps/
+ permalink: python/density-heatmaps/
+ redirect_from: python/mapbox-density-heatmaps/
thumbnail: thumbnail/mapbox-density.png
---
-#### Mapbox Access Token
-
-To plot on Mapbox maps with Plotly, you may need a [Mapbox account and token](https://www.mapbox.com/studio) or a [Stadia Maps account and token](https://www.stadiamaps.com), depending on base map (`mapbox_style`) you use. On this page, we show how to use the "open-street-map" base map, which doesn't require a token, and a "stamen" base map, which requires a Stadia Maps token. See our [Mapbox Map Layers](/python/mapbox-layers/) documentation for more examples.
-
-### OpenStreetMap base map (no token needed): density mapbox with `plotly.express`
+### Density map with `plotly.express`
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
-With `px.density_mapbox`, each row of the DataFrame is represented as a point smoothed with a given radius of influence.
+With `px.density_map`, each row of the DataFrame is represented as a point smoothed with a given radius of influence.
```python
import pandas as pd
df = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/earthquakes-23k.csv')
import plotly.express as px
-fig = px.density_mapbox(df, lat='Latitude', lon='Longitude', z='Magnitude', radius=10,
+fig = px.density_map(df, lat='Latitude', lon='Longitude', z='Magnitude', radius=10,
center=dict(lat=0, lon=180), zoom=0,
- mapbox_style="open-street-map")
+ map_style="open-street-map")
fig.show()
```
-
-### Stamen Terrain base map (Stadia Maps token needed): density mapbox with `plotly.express`
+### Density map with `plotly.graph_objects`
-Some base maps require a token. To use "stamen" base maps, you'll need a [Stadia Maps](https://www.stadiamaps.com) token, which you can provide to the `mapbox_accesstoken` parameter on `fig.update_layout`. Here, we have the token saved in a file called `.mapbox_token`, load it in to the variable `token`, and then pass it to `mapbox_accesstoken`.
+If Plotly Express does not provide a good starting point, it is also possible to use [the more generic `go.Densitymap` class from `plotly.graph_objects`](/python/graph-objects/).
```python
-import plotly.express as px
import pandas as pd
+quakes = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/earthquakes-23k.csv')
-token = open(".mapbox_token").read() # you will need your own token
-
-df = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/earthquakes-23k.csv')
-
-fig = px.density_mapbox(df, lat='Latitude', lon='Longitude', z='Magnitude', radius=10,
- center=dict(lat=0, lon=180), zoom=0,
- mapbox_style="stamen-terrain")
-fig.update_layout(mapbox_accesstoken=token)
+import plotly.graph_objects as go
+fig = go.Figure(go.Densitymap(lat=quakes.Latitude, lon=quakes.Longitude, z=quakes.Magnitude,
+ radius=10))
+fig.update_layout(map_style="open-street-map", map_center_lon=180)
+fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
fig.show()
```
-
+
+### Mapbox Maps
+
+> Mapbox traces are deprecated and may be removed in a future version of Plotly.py.
-### OpenStreetMap base map (no token needed): density mapbox with `plotly.graph_objects`
+The earlier examples using `px.density_map` and `go.Densitymap` use [Maplibre](https://maplibre.org/maplibre-gl-js/docs/) for rendering. These traces were introduced in Plotly.py 5.24. These trace types are now the recommended way to make tile-based density heatmaps. There are also traces that use [Mapbox](https://docs.mapbox.com): `density_mapbox` and `go.Densitymapbox`.
-If Plotly Express does not provide a good starting point, it is also possible to use [the more generic `go.Densitymapbox` class from `plotly.graph_objects`](/python/graph-objects/).
+To use these trace types, in some cases 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.
+
+Here's one of the earlier examples rewritten to use `px.density_mapbox`.
```python
import pandas as pd
-quakes = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/earthquakes-23k.csv')
+df = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/earthquakes-23k.csv')
-import plotly.graph_objects as go
-fig = go.Figure(go.Densitymapbox(lat=quakes.Latitude, lon=quakes.Longitude, z=quakes.Magnitude,
- radius=10))
-fig.update_layout(mapbox_style="open-street-map", mapbox_center_lon=180)
-fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
+import plotly.express as px
+fig = px.density_mapbox(df, lat='Latitude', lon='Longitude', z='Magnitude', radius=10,
+ center=dict(lat=0, lon=180), zoom=0,
+ mapbox_style="open-street-map")
fig.show()
```
+
+
-### Stamen Terrain base map (Stadia Maps token needed): density mapbox with `plotly.graph_objects`
+#### Stamen Terrain base map with Mapbox (Stadia Maps token needed): density heatmap with `plotly.express`
Some base maps require a token. To use "stamen" base maps, you'll need a [Stadia Maps](https://www.stadiamaps.com) token, which you can provide to the `mapbox_accesstoken` parameter on `fig.update_layout`. Here, we have the token saved in a file called `.mapbox_token`, load it in to the variable `token`, and then pass it to `mapbox_accesstoken`.
-
```python
-import plotly.graph_objects as go
+import plotly.express as px
import pandas as pd
token = open(".mapbox_token").read() # you will need your own token
-quakes = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/earthquakes-23k.csv')
+df = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/earthquakes-23k.csv')
-fig = go.Figure(go.Densitymapbox(lat=quakes.Latitude, lon=quakes.Longitude, z=quakes.Magnitude,
- radius=10))
-fig.update_layout(mapbox_style="stamen-terrain", mapbox_center_lon=180, mapbox_accesstoken=token)
-fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
+fig = px.density_mapbox(df, lat='Latitude', lon='Longitude', z='Magnitude', radius=10,
+ center=dict(lat=0, lon=180), zoom=0,
+ map_style="stamen-terrain")
+fig.update_layout(mapbox_accesstoken=token)
fig.show()
```
+
+
#### Reference
-See [function reference for `px.(density_mapbox)`](https://plotly.com/python-api-reference/generated/plotly.express.density_mapbox) or https://plotly.com/python/reference/densitymapbox/ for more information about mapbox and their attribute options.
+See [function reference for `px.(density_map)`](https://plotly.com/python-api-reference/generated/plotly.express.density_mapbox) or https://plotly.com/python/reference/densitymap/ for available attribute options.
+
+For Mapbox-based maps, see [function reference for `px.(density_mapbox)`](https://plotly.com/python-api-reference/generated/plotly.express.density_mapbox) or https://plotly.com/python/reference/densitymapbox/.
diff --git a/doc/python/mapbox-layers.md b/doc/python/mapbox-layers.md
index e7b672637d3..6e11ef71822 100644
--- a/doc/python/mapbox-layers.md
+++ b/doc/python/mapbox-layers.md
@@ -6,7 +6,7 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.3'
- jupytext_version: 1.14.6
+ jupytext_version: 1.16.3
kernelspec:
display_name: Python 3 (ipykernel)
language: python
@@ -20,63 +20,83 @@ jupyter:
name: python
nbconvert_exporter: python
pygments_lexer: ipython3
- version: 3.10.11
+ version: 3.10.0
plotly:
- description: How to make Mapbox maps in Python with various base layers, with
- or without needing a Mapbox Access token.
+ description: How to make tile-based maps in Python with various base layers.
display_as: maps
language: python
layout: base
- name: Mapbox Map Layers
- order: 8
+ name: Tile Map Layers
+ order: 9
page_type: u-guide
- permalink: python/mapbox-layers/
+ permalink: /python/tile-map-layers/
+ redirect_from: /python/mapbox-layers/
thumbnail: thumbnail/mapbox-layers.png
---
-### Mapbox Maps vs Geo Maps
+## Tile Maps vs Outline Maps
Plotly supports two different kinds of maps:
-1. **Mapbox maps** are [tile-based maps](https://en.wikipedia.org/wiki/Tiled_web_map). If your figure is created with a `px.scatter_mapbox`, `px.line_mapbox`, `px.choropleth_mapbox` or `px.density_mapbox` function or otherwise contains one or more traces of type `go.Scattermapbox`, `go.Choroplethmapbox` or `go.Densitymapbox`, the `layout.mapbox` object in your figure contains configuration information for the map itself.
-2. **Geo maps** are outline-based maps. If your figure is created with a `px.scatter_geo`, `px.line_geo` or `px.choropleth` function or otherwise contains one or more traces of type `go.Scattergeo` or `go.Choropleth`, the `layout.geo` object in your figure contains configuration information for the map itself.
+- **[Tile-based maps](https://en.wikipedia.org/wiki/Tiled_web_map)**
-This page documents Mapbox tile-based maps, and the [Geo map documentation](/python/map-configuration/) describes how to configure outline-based maps.
+If your figure is created with a `px.scatter_map`, `px_scatter_mapbox`, `px.line_map`, `px.line_mapbox`, `px.choropleth_map`, `px.choropleth_mapbox`, `px.density_map`, or `px.density_mapbox` function or otherwise contains one or more traces of type `go.Scattermap`, `go.Scattermapbox`, `go.Choroplethmap`, `go.Choroplethmapbox`, `go.Densitymap`, or `go.Densitymapbox`, the `layout.map` or `layout.mapbox` object in your figure contains configuration information for the map itself.
-#### How Layers Work in Mapbox Tile Maps
+- **Outline-based maps**
-Mapbox tile maps are composed of various layers, of three different types:
+Geo maps are outline-based maps. If your figure is created with a `px.scatter_geo`, `px.line_geo` or `px.choropleth` function or otherwise contains one or more traces of type `go.Scattergeo` or `go.Choropleth`, the `layout.geo` object in your figure contains configuration information for the map itself.
-1. `layout.mapbox.style` defines is the lowest layers, also known as your "base map"
-2. The various traces in `data` are by default rendered above the base map (although this can be controlled via the `below` attribute).
-3. `layout.mapbox.layers` is an array that defines more layers that are by default rendered above the traces in `data` (although this can also be controlled via the `below` attribute).
+> This page documents tile-based maps, and the [Geo map documentation](/python/map-configuration/) describes how to configure outline-based maps.
-#### Mapbox Access Tokens and When You Need Them
+## Tile Map Renderers
-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.
+Tile-based traces in Plotly use Maplibre or Mapbox.
-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).
+Maplibre-based traces (new in 5.24) are ones generated in Plotly Express using `px.scatter_map`, `px.line_map`, `px.choropleth_map`, `px.density_map`, or Graph Objects using `go.Scattermap`, `go.Choroplethmap`, or `go.Densitymap`.
-If you basemap in `layout.mapbox.style` uses maps from the [Stadia Maps service](https://www.stadiamaps.com) (see below for details), you'll need to register for a Stadia Maps account and token.
+Mapbox-based traces are suffixed with `mapbox`, for example `go.Scattermapbox`. These are deprecated as of version 5.24 and we recommend using the Maplibre-based traces.
+### Maplibre
-#### Base Maps in `layout.mapbox.style`
+*New in 5.24*
-The accepted values for `layout.mapbox.style` are one of:
+Maplibre-based tile maps have three different types of layers:
-- `"white-bg"` yields an empty white canvas which results in no external HTTP requests
-- `"open-street-map"`, `"carto-positron"`, and `"carto-darkmatter"` yield maps composed of _raster_ tiles from various public tile servers which do not require signups or access tokens.
-- `"basic"`, `"streets"`, `"outdoors"`, `"light"`, `"dark"`, `"satellite"`, or `"satellite-streets"` yield maps composed of _vector_ tiles from the Mapbox service, and _do_ require a Mapbox Access Token or an on-premise Mapbox installation.
-- `"stamen-terrain"`, `"stamen-toner"` or `"stamen-watercolor"` yield maps composed of _raster_ tiles from the [Stadia Maps service](https://www.stadiamaps.com), and require a Stadia Maps account and token.
-- A Mapbox service style URL, which requires a Mapbox Access Token or an on-premise Mapbox installation.
-- A Mapbox Style object as defined at https://docs.mapbox.com/mapbox-gl-js/style-spec/
+- `layout.map.style` defines the lowest layers of the map, also known as the "base map".
+- The various traces in `data` are by default rendered above the base map (although this can be controlled via the `below` attribute).
+- `layout.map.layers` is an array that defines more layers that are by default rendered above the traces in `data` (although this can also be controlled via the `below` attribute.
-#### OpenStreetMap tiles: no token needed
-Here is a simple map rendered with OpenStreetMaps tiles, without needing a Mapbox Access Token:
+#### Base Maps in `layout.map.style`.
+
+The accepted values for `layout.map.style` are one of:
+
+- "basic"
+- "carto-darkmatter"
+- "carto-darkmatter-nolabels"
+- "carto-positron"
+- "carto-positron-nolabels"
+- "carto-voyager"
+- "carto-voyager-nolabels"
+- "dark"
+- "light"
+- "open-street-map"
+- "outdoors"
+- "satellite"
+- "satellite-streets"
+- "streets"
+- "white-bg" - an empty white canvas which results in no external HTTP requests
+
+- A custom style URL. For example: https://tiles.stadiamaps.com/styles/stamen_watercolor.json?api_key=YOUR-API-KEY
+- A Map Style object as defined at https://maplibre.org/maplibre-style-spec/
+
+
+#### OpenStreetMap tiles
+
+Here is a simple map rendered with OpenStreetMaps tiles.
```python
@@ -85,24 +105,22 @@ us_cities = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/maste
import plotly.express as px
-fig = px.scatter_mapbox(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
+fig = px.scatter_map(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
color_discrete_sequence=["fuchsia"], zoom=3, height=300)
-fig.update_layout(mapbox_style="open-street-map")
+fig.update_layout(map_style="open-street-map")
fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
fig.show()
```
+#### Using `layout.map.layers` to Specify a Base Map
-#### Using `layout.mapbox.layers` to Specify a Base Map
-
-If you have access to your own private tile servers, or wish to use a tile server not included in the list above, the recommended approach is to set `layout.mapbox.style` to `"white-bg"` and to use `layout.mapbox.layers` with `below` to specify a custom base map.
+If you have access to your own private tile servers, or wish to use a tile server not included in the list above, the recommended approach is to set `layout.map.style` to `"white-bg"` and to use `layout.map.layers` with `below` to specify a custom base map.
> If you omit the `below` attribute when using this approach, your data will likely be hidden by fully-opaque raster tiles!
#### Base Tiles from the USGS: no token needed
-Here is an example of a map which uses a public USGS imagery map, specified in `layout.mapbox.layers`, and which is rendered _below_ the `data` layer.
-
+Here is an example of a map which uses a public USGS imagery map, specified in `layout.map.layers`, and which is rendered _below_ the `data` layer.
```python
import pandas as pd
@@ -110,11 +128,11 @@ us_cities = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/maste
import plotly.express as px
-fig = px.scatter_mapbox(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
+fig = px.scatter_map(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
color_discrete_sequence=["fuchsia"], zoom=3, height=300)
fig.update_layout(
- mapbox_style="white-bg",
- mapbox_layers=[
+ map_style="white-bg",
+ map_layers=[
{
"below": 'traces',
"sourcetype": "raster",
@@ -129,9 +147,9 @@ fig.show()
```
-#### Base Tiles from the USGS, radar overlay from Environment Canada: no token needed
+#### Base Tiles from the USGS, radar overlay from Environment Canada
-Here is the same example, with in addition, a WMS layer from Environment Canada which displays near-real-time radar imagery in partly-transparent raster tiles, rendered above the `go.Scattermapbox` trace, as is the default:
+Here is the same example, with in addition, a WMS layer from Environment Canada which displays near-real-time radar imagery in partly-transparent raster tiles, rendered above the `go.Scattermap` trace, as is the default:
```python
@@ -140,11 +158,11 @@ us_cities = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/maste
import plotly.express as px
-fig = px.scatter_mapbox(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
+fig = px.scatter_map(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
color_discrete_sequence=["fuchsia"], zoom=3, height=300)
fig.update_layout(
- mapbox_style="white-bg",
- mapbox_layers=[
+ map_style="white-bg",
+ map_layers=[
{
"below": 'traces',
"sourcetype": "raster",
@@ -166,14 +184,80 @@ fig.show()
```
-#### Dark tiles from Mapbox service: free token needed
+#### Dark tiles example
-Here is a map rendered with the `"dark"` style from the Mapbox service, which requires an Access Token:
+Here is a map rendered with the `"dark"` style.
+```python
+import pandas as pd
+us_cities = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/us-cities-top-1k.csv")
+
+import plotly.express as px
+
+fig = px.scatter_map(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
+ color_discrete_sequence=["fuchsia"], zoom=3, height=300)
+fig.update_layout(map_style="dark")
+fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
+fig.show()
+```
+
+
+#### Stamen Watercolor using a Custom Style URL
+
+Here's an example of using a custom style URL that points to the [Stadia Maps](https://docs.stadiamaps.com/map-styles/stamen-watercolor) service to use the `stamen_watercolor` base map.
```python
-token = open(".mapbox_token").read() # you will need your own token
+import pandas as pd
+quakes = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/earthquakes-23k.csv')
+
+import plotly.graph_objects as go
+fig = go.Figure(go.Densitymap(lat=quakes.Latitude, lon=quakes.Longitude, z=quakes.Magnitude,
+ radius=10))
+fig.update_layout(map_style="https://tiles.stadiamaps.com/styles/stamen_watercolor.json?api_key=YOUR-API-KEY", map_center_lon=180)
+fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
+fig.show()
+```
+
+
+
+### Mapbox
+
+> Mapbox traces are deprecated and may be removed in a future version of Plotly.py.
+
+#### How Layers Work in Mapbox Tile Maps
+
+Mapbox tile maps are composed of various layers, of three different types:
+
+1. `layout.mapbox.style` defines is the lowest layers, also known as your "base map"
+2. The various traces in `data` are by default rendered above the base map (although this can be controlled via the `below` attribute).
+3. `layout.mapbox.layers` is an array that defines more layers that are by default rendered above the traces in `data` (although this can also be controlled via the `below` attribute).
+
+#### Mapbox Access Tokens and When You Need Them
+
+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 you basemap in `layout.mapbox.style` uses maps from the [Stadia Maps service](https://www.stadiamaps.com) (see below for details), you'll need to register for a Stadia Maps account and token.
+
+
+#### Base Maps in `layout.mapbox.style`
+
+The accepted values for `layout.mapbox.style` are one of:
+
+- `"white-bg"` yields an empty white canvas which results in no external HTTP requests
+- `"open-street-map"`, `"carto-positron"`, and `"carto-darkmatter"` yield maps composed of _raster_ tiles from various public tile servers which do not require signups or access tokens.
+- `"basic"`, `"streets"`, `"outdoors"`, `"light"`, `"dark"`, `"satellite"`, or `"satellite-streets"` yield maps composed of _vector_ tiles from the Mapbox service, and _do_ require a Mapbox Access Token or an on-premise Mapbox installation.
+- `"stamen-terrain"`, `"stamen-toner"` or `"stamen-watercolor"` yield maps composed of _raster_ tiles from the [Stadia Maps service](https://www.stadiamaps.com), and require a Stadia Maps account and token.
+- A Mapbox service style URL, which requires a Mapbox Access Token or an on-premise Mapbox installation.
+- A Mapbox Style object as defined at https://docs.mapbox.com/mapbox-gl-js/style-spec/
+
+#### OpenStreetMap tiles: no token needed
+
+Here is a simple map rendered with OpenStreetMaps tiles, without needing a Mapbox Access Token:
+
+
+```python
import pandas as pd
us_cities = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/us-cities-top-1k.csv")
@@ -181,17 +265,66 @@ import plotly.express as px
fig = px.scatter_mapbox(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
color_discrete_sequence=["fuchsia"], zoom=3, height=300)
-fig.update_layout(mapbox_style="dark", mapbox_accesstoken=token)
+fig.update_layout(mapbox_style="open-street-map")
+fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
+fig.show()
+```
+
+#### Using `layout.mapbox.layers` to Specify a Base Map
+
+If you have access to your own private tile servers, or wish to use a tile server not included in the list above, the recommended approach is to set `layout.mapbox.style` to `"white-bg"` and to use `layout.mapbox.layers` with `below` to specify a custom base map.
+
+> If you omit the `below` attribute when using this approach, your data will likely be hidden by fully-opaque raster tiles!
+
+#### Base Tiles from the USGS: no token needed
+
+Here is an example of a map which uses a public USGS imagery map, specified in `layout.mapbox.layers`, and which is rendered _below_ the `data` layer.
+
+
+```python
+import pandas as pd
+us_cities = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/us-cities-top-1k.csv")
+
+import plotly.express as px
+
+fig = px.scatter_mapbox(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
+ color_discrete_sequence=["fuchsia"], zoom=3, height=300)
+fig.update_layout(
+ mapbox_style="white-bg",
+ mapbox_layers=[
+ {
+ "below": 'traces',
+ "sourcetype": "raster",
+ "sourceattribution": "United States Geological Survey",
+ "source": [
+ "https://basemap.nationalmap.gov/arcgis/rest/services/USGSImageryOnly/MapServer/tile/{z}/{y}/{x}"
+ ]
+ }
+ ])
fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
fig.show()
```
-#### Using a mapbox image layer to display a datashader raster image
+#### Dark tiles from Mapbox service: free token needed
+
+Here is a map rendered with the `"dark"` style from the Mapbox service, which requires an Access Token:
+
+```python
+token = open(".mapbox_token").read() # you will need your own token
+
+import pandas as pd
+us_cities = pd.read_csv("https://raw.githubusercontent.com/plotly/datasets/master/us-cities-top-1k.csv")
-See the example in the [plotly and datashader tutorial](/python/datashader).
+import plotly.express as px
+fig = px.scatter_mapbox(us_cities, lat="lat", lon="lon", hover_name="City", hover_data=["State", "Population"],
+ color_discrete_sequence=["fuchsia"], zoom=3, height=300)
+fig.update_layout(mapbox_style="dark", mapbox_accesstoken=token)
+fig.update_layout(margin={"r":0,"t":0,"l":0,"b":0})
+fig.show()
+```
-#### Setting Map Bounds
+## Setting Map Bounds
*New in 5.11*
@@ -205,7 +338,7 @@ us_cities = pd.read_csv(
"https://raw.githubusercontent.com/plotly/datasets/master/us-cities-top-1k.csv"
)
-fig = px.scatter_mapbox(
+fig = px.scatter_map(
us_cities,
lat="lat",
lon="lon",
@@ -215,12 +348,12 @@ fig = px.scatter_mapbox(
zoom=3,
height=300,
)
-fig.update_layout(mapbox_style="open-street-map")
+fig.update_layout(map_style="open-street-map")
fig.update_layout(margin={"r": 0, "t": 0, "l": 0, "b": 0})
-fig.update_layout(mapbox_bounds={"west": -180, "east": -50, "south": 20, "north": 90})
+fig.update_layout(map_bounds={"west": -180, "east": -50, "south": 20, "north": 90})
fig.show()
```
#### Reference
-See https://plotly.com/python/reference/layout/mapbox/ for more information and options!
+See https://plotly.com/python/reference/layout/map/ for more information and options on Maplibre-based tile maps and https://plotly.com/python/reference/layout/mapbox/ for Mapbox-based tile maps.
diff --git a/doc/python/migrate-to-maplibre.md b/doc/python/migrate-to-maplibre.md
new file mode 100644
index 00000000000..d7576fef50f
--- /dev/null
+++ b/doc/python/migrate-to-maplibre.md
@@ -0,0 +1,75 @@
+---
+jupyter:
+ jupytext:
+ notebook_metadata_filter: all
+ text_representation:
+ extension: .md
+ format_name: markdown
+ format_version: '1.3'
+ jupytext_version: 1.16.1
+ kernelspec:
+ display_name: Python 3 (ipykernel)
+ 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.10.11
+ plotly:
+ description: Migrating from Mapbox traces to MapLibre traces.
+ display_as: maps
+ language: python
+ layout: base
+ name: MapLibre Migration
+ order: 1
+ page_type: u-guide
+ permalink: python/mapbox-to-maplibre/
+ thumbnail: thumbnail/mapbox-layers.png
+---
+
+## Migrating from Mapbox traces to MapLibre traces
+
+With the release of Plotly.py v5.24.0, we are introducing a new set of trace types for maps with tile underlays, including from Plotly Express:
+- `px.scatter_map`
+- `px.line_map`
+- `px.choropleth_map`
+- `px.density_map`
+
+as well as Plotly Graph Objects:
+- `go.Choroplethmap`
+- `go.Scattermap`
+- `go.Densitymap`
+
+These traces replace the existing Mapbox traces, `px.scatter_mapbox`, `px.line_mapbox`, etc., but use [MapLibre](https://maplibre.org) as the map renderer rather than Mapbox.
+
+When switching to the new traces, keep an eye out for improved rendering performance, WebGL2 support, and over time, improved features in the Plotly map traces inherited from the MapLibre renderer, including projection support, globe views, terrain support, and support for modern mapping standards.
+
+You can learn more about the motivations for this change in our [announcement post](https://plotly.com/blog/plotly-is-switching-to-maplibre/).
+
+As a result of removing Mapbox as the rendering engine, we're also removing the Mapbox branding from these trace names. This means that migrating from Mapbox traces to MapLibre traces will require some code changes in your projects.
+
+1. Change trace names from `*mapbox` to `*map`. For any existing trace name ending in `*mapbox`, ensure you've removed the "`box`" suffix.
+2. If in use, update `layout.mapbox` argument in your layout configuration to `layout.map`. The nested properties are identical in the new map traces, so no other changes should be required.
+3. If in use, update `mapbox_style` to `map_style`.
+4. Verify your `map_style` settings. With `mapbox` traces, we bundle `basic`, `streets`, `outdoors`, `light`, `dark`, `satellite`, and `satellite-streets` styles, using Mapbox styling. These style names are still available, but they now reference slightly different styles provided by other tools.
+
+Note that Mapbox API keys are no longer required for Plotly-provided styles, but using external styles in your Plotly maps remains supported with the existing API.
+
+### Style changes
+Built-in styles in map traces are free styles from [Carto](https://carto.com) and [ESRI](https://www.esri.com/en-us/home). Several names are re-used from the previous Mapbox styles.
+
+ 
+ 
+
+
+Compare to the previous Mapbox styles:
+
+ 
+ 
+
\ No newline at end of file
diff --git a/doc/python/plotly-express.md b/doc/python/plotly-express.md
index 4e4c30e8f31..0aebc72dccf 100644
--- a/doc/python/plotly-express.md
+++ b/doc/python/plotly-express.md
@@ -60,7 +60,7 @@ Plotly Express currently includes the following functions:
* **Matrix or Image Input**: [`imshow`](/python/imshow/)
* **3-Dimensional**: [`scatter_3d`](/python/3d-scatter-plots/), [`line_3d`](/python/3d-line-plots/)
* **Multidimensional**: [`scatter_matrix`](/python/splom/), [`parallel_coordinates`](/python/parallel-coordinates-plot/), [`parallel_categories`](/python/parallel-categories-diagram/)
-* **Tile Maps**: [`scatter_mapbox`](/python/scattermapbox/), [`line_mapbox`](/python/lines-on-mapbox/), [`choropleth_mapbox`](/python/mapbox-county-choropleth/), [`density_mapbox`](/python/mapbox-density-heatmaps/)
+* **Tile Maps**: [`scatter_map`](/python/tile-scatter-maps/), [`line_map`](/python/lines-on-tile-maps/), [`choropleth_map`](/python/tile-county-choropleth/), [`density_map`](/python/tile-density-heatmaps/)
* **Outline Maps**: [`scatter_geo`](/python/scatter-plots-on-maps/), [`line_geo`](/python/lines-on-maps/), [`choropleth`](/python/choropleth-maps/)
* **Polar Charts**: [`scatter_polar`](/python/polar-chart/), [`line_polar`](/python/polar-chart/), [`bar_polar`](/python/wind-rose-charts/)
* **Ternary Charts**: [`scatter_ternary`](/python/ternary-plots/), [`line_ternary`](/python/ternary-plots/)
@@ -393,18 +393,18 @@ fig.show()
#### Tile Maps
-**Read more about [tile maps](/python/mapbox-layers/) and [point on tile maps](/python/scattermapbox/).**
+**Read more about [tile maps](/python/tile-map-layers/) and [point on tile maps](/python/tile-scatter-maps/).**
```python
import plotly.express as px
df = px.data.carshare()
-fig = px.scatter_mapbox(df, lat="centroid_lat", lon="centroid_lon", color="peak_hour", size="car_hours",
+fig = px.scatter_map(df, lat="centroid_lat", lon="centroid_lon", color="peak_hour", size="car_hours",
color_continuous_scale=px.colors.cyclical.IceFire, size_max=15, zoom=10,
- mapbox_style="carto-positron")
+ map_style="carto-positron")
fig.show()
```
-**Read more about [tile map GeoJSON choropleths](/python/mapbox-county-choropleth/).**
+**Read more about [tile map GeoJSON choropleths](/python/tile-county-choropleth/).**
```python
import plotly.express as px
@@ -412,10 +412,10 @@ import plotly.express as px
df = px.data.election()
geojson = px.data.election_geojson()
-fig = px.choropleth_mapbox(df, geojson=geojson, color="Bergeron",
+fig = px.choropleth_map(df, geojson=geojson, color="Bergeron",
locations="district", featureidkey="properties.district",
center={"lat": 45.5517, "lon": -73.7073},
- mapbox_style="carto-positron", zoom=9)
+ map_style="carto-positron", zoom=9)
fig.show()
```
diff --git a/doc/python/scatter-plots-on-maps.md b/doc/python/scatter-plots-on-maps.md
index 53b582fa128..9c4ad70bea8 100644
--- a/doc/python/scatter-plots-on-maps.md
+++ b/doc/python/scatter-plots-on-maps.md
@@ -28,7 +28,7 @@ jupyter:
language: python
layout: base
name: Scatter Plots on Maps
- order: 11
+ order: 12
page_type: u-guide
permalink: python/scatter-plots-on-maps/
thumbnail: thumbnail/scatter-plot-on-maps.jpg
diff --git a/doc/python/scattermapbox.md b/doc/python/scattermapbox.md
index 1bd58271686..82f54d90f3b 100644
--- a/doc/python/scattermapbox.md
+++ b/doc/python/scattermapbox.md
@@ -6,7 +6,7 @@ jupyter:
extension: .md
format_name: markdown
format_version: '1.3'
- jupytext_version: 1.16.2
+ jupytext_version: 1.16.3
kernelspec:
display_name: Python 3 (ipykernel)
language: python
@@ -22,39 +22,35 @@ jupyter:
pygments_lexer: ipython3
version: 3.10.0
plotly:
- description: How to make scatter plots on Mapbox maps in Python.
+ description: How to make scatter plots on tile maps in Python.
display_as: maps
language: python
layout: base
- name: Scatter Plots on Mapbox
- order: 9
+ name: Scatter Plots on Tile Maps
+ order: 10
page_type: u-guide
- permalink: python/scattermapbox/
+ permalink: python/tile-scatter-maps/
+ redirect_from: python/scattermapbox/
thumbnail: thumbnail/scatter-mapbox.jpg
---
-#### Mapbox Access Token and Base Map Configuration
-
-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.
-
### Basic example with Plotly Express
-Here we show the [Plotly Express](/python/plotly-express/) function `px.scatter_mapbox` for a scatter plot on a tile map.
+Here we show the [Plotly Express](/python/plotly-express/) function `px.scatter_map` for a scatter plot on a tile map.
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
```python
import plotly.express as px
-px.set_mapbox_access_token(open(".mapbox_token").read())
df = px.data.carshare()
-fig = px.scatter_mapbox(df, lat="centroid_lat", lon="centroid_lon", color="peak_hour", size="car_hours",
+fig = px.scatter_map(df, lat="centroid_lat", lon="centroid_lon", color="peak_hour", size="car_hours",
color_continuous_scale=px.colors.cyclical.IceFire, size_max=15, zoom=10)
fig.show()
```
### Basic Example with GeoPandas
-`px.scatter_mapbox` can work well with [GeoPandas](https://geopandas.org/) dataframes whose `geometry` is of type `Point`.
+`px.scatter_map` can work well with [GeoPandas](https://geopandas.org/) dataframes whose `geometry` is of type `Point`.
```python
import plotly.express as px
@@ -62,8 +58,7 @@ import geopandas as gpd
geo_df = gpd.read_file(gpd.datasets.get_path('naturalearth_cities'))
-px.set_mapbox_access_token(open(".mapbox_token").read())
-fig = px.scatter_mapbox(geo_df,
+fig = px.scatter_map(geo_df,
lat=geo_df.geometry.y,
lon=geo_df.geometry.x,
hover_name="name",
@@ -76,13 +71,11 @@ fig.show()
```python
import plotly.graph_objects as go
-mapbox_access_token = open(".mapbox_token").read()
-
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
lat=['45.5017'],
lon=['-73.5673'],
mode='markers',
- marker=go.scattermapbox.Marker(
+ marker=go.scattermap.Marker(
size=14
),
text=['Montreal'],
@@ -90,10 +83,9 @@ fig = go.Figure(go.Scattermapbox(
fig.update_layout(
hovermode='closest',
- mapbox=dict(
- accesstoken=mapbox_access_token,
+ map=dict(
bearing=0,
- center=go.layout.mapbox.Center(
+ center=go.layout.map.Center(
lat=45,
lon=-73
),
@@ -110,9 +102,7 @@ fig.show()
```python
import plotly.graph_objects as go
-mapbox_access_token = open(".mapbox_token").read()
-
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
lat=['38.91427','38.91538','38.91458',
'38.92239','38.93222','38.90842',
'38.91931','38.93260','38.91368',
@@ -124,7 +114,7 @@ fig = go.Figure(go.Scattermapbox(
'-76.99656','-77.042438','-77.02821',
'-77.01239'],
mode='markers',
- marker=go.scattermapbox.Marker(
+ marker=go.scattermap.Marker(
size=9
),
text=["The coffee bar","Bistro Bohem","Black Cat",
@@ -137,8 +127,7 @@ fig = go.Figure(go.Scattermapbox(
fig.update_layout(
autosize=True,
hovermode='closest',
- mapbox=dict(
- accesstoken=mapbox_access_token,
+ map=dict(
bearing=0,
center=dict(
lat=38.92,
@@ -158,8 +147,6 @@ fig.show()
import plotly.graph_objects as go
import pandas as pd
-mapbox_access_token = open(".mapbox_token").read()
-
df = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/Nuclear%20Waste%20Sites%20on%20American%20Campuses.csv')
site_lat = df.lat
site_lon = df.lon
@@ -167,11 +154,11 @@ locations_name = df.text
fig = go.Figure()
-fig.add_trace(go.Scattermapbox(
+fig.add_trace(go.Scattermap(
lat=site_lat,
lon=site_lon,
mode='markers',
- marker=go.scattermapbox.Marker(
+ marker=go.scattermap.Marker(
size=17,
color='rgb(255, 0, 0)',
opacity=0.7
@@ -180,11 +167,11 @@ fig.add_trace(go.Scattermapbox(
hoverinfo='text'
))
-fig.add_trace(go.Scattermapbox(
+fig.add_trace(go.Scattermap(
lat=site_lat,
lon=site_lon,
mode='markers',
- marker=go.scattermapbox.Marker(
+ marker=go.scattermap.Marker(
size=8,
color='rgb(242, 177, 172)',
opacity=0.7
@@ -197,8 +184,7 @@ fig.update_layout(
autosize=True,
hovermode='closest',
showlegend=False,
- mapbox=dict(
- accesstoken=mapbox_access_token,
+ map=dict(
bearing=0,
center=dict(
lat=38,
@@ -215,7 +201,7 @@ fig.show()
### Set Marker Symbols
-You can define a symbol on your map by setting [symbol](https://plotly.com/python/reference/scattermapbox/#scattermapbox-marker-symbol) attribute. This attribute only works on Mapbox-provided `style`s:
+You can define the symbol on your map by setting [`symbol`](https://plotly.com/python/reference/scattermap/#scattermap-marker-symbol) attribute.
- basic
- streets
@@ -228,17 +214,14 @@ You can define a symbol on your map by setting [symbol](https://plotly.com/pytho
```python
import plotly.graph_objects as go
-token = open(".mapbox_token").read() # you need your own token
-
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
mode = "markers+text+lines",
lon = [-75, -80, -50], lat = [45, 20, -20],
marker = {'size': 20, 'symbol': ["bus", "harbor", "airport"]},
text = ["Bus", "Harbor", "airport"],textposition = "bottom right"))
fig.update_layout(
- mapbox = {
- 'accesstoken': token,
+ map = {
'style': "outdoors", 'zoom': 0.7},
showlegend = False)
@@ -255,11 +238,10 @@ Display clusters of data points by setting `cluster`. Here, we enable clusters w
import plotly.express as px
import pandas as pd
-px.set_mapbox_access_token(open(".mapbox_token").read())
df = pd.read_csv(
"https://raw.githubusercontent.com/plotly/datasets/master/2011_february_us_airport_traffic.csv"
)
-fig = px.scatter_mapbox(df, lat="lat", lon="long", size="cnt", zoom=3)
+fig = px.scatter_map(df, lat="lat", lon="long", size="cnt", zoom=3)
fig.update_traces(cluster=dict(enabled=True))
fig.show()
@@ -267,14 +249,12 @@ fig.show()
#### Font Customization
-You can customize the font on `go.Scattermapbox` traces with `textfont`. For example, you can set the font `family`.
+You can customize the font on `go.Scattermap` traces with `textfont`. For example, you can set the font `family`.
```python
import plotly.graph_objects as go
-token = open(".mapbox_token").read() # you need your own token
-
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
mode = "markers+text+lines",
lon = [-75, -80, -50], lat = [45, 20, -20],
marker = {'size': 20, 'symbol': ["bus", "harbor", "airport"]},
@@ -283,15 +263,14 @@ fig = go.Figure(go.Scattermapbox(
))
fig.update_layout(
- mapbox = {
- 'accesstoken': token,
+ map = {
'style': "outdoors", 'zoom': 0.7},
showlegend = False,)
fig.show()
```
-`go.Scattermapbox` supports the following values for `textfont.family`:
+`go.Scattermap` supports the following values for `textfont.family`:
'Metropolis Black Italic', 'Metropolis Black', 'Metropolis Bold Italic', 'Metropolis Bold', 'Metropolis Extra Bold Italic', 'Metropolis Extra Bold', 'Metropolis Extra Light Italic', 'Metropolis Extra Light', 'Metropolis Light Italic', 'Metropolis Light', 'Metropolis Medium Italic', 'Metropolis Medium', 'Metropolis Regular Italic', 'Metropolis Regular', 'Metropolis Semi Bold Italic', 'Metropolis Semi Bold', 'Metropolis Thin Italic', 'Metropolis Thin', 'Open Sans Bold Italic', 'Open Sans Bold', 'Open Sans Extrabold Italic', 'Open Sans Extrabold', 'Open Sans Italic', 'Open Sans Light Italic', 'Open Sans Light', 'Open Sans Regular', 'Open Sans Semibold Italic', 'Open Sans Semibold', 'Klokantech Noto Sans Bold', 'Klokantech Noto Sans CJK Bold', 'Klokantech Noto Sans CJK Regular', 'Klokantech Noto Sans Italic', and 'Klokantech Noto Sans Regular'.
@@ -300,14 +279,12 @@ fig.show()
*New in 5.23*
-You can specify a numeric font weight on `go.Scattermapbox` with `textfont.weight`.
+You can specify a numeric font weight on `go.Scattermap` with `textfont.weight`.
```python
import plotly.graph_objects as go
-token = open(".mapbox_token").read() # you need your own token
-
-fig = go.Figure(go.Scattermapbox(
+fig = go.Figure(go.Scattermap(
mode = "markers+text+lines",
lon = [-75, -80, -50], lat = [45, 20, -20],
marker = dict(size=20, symbol=["bus", "harbor", "airport"]),
@@ -316,14 +293,69 @@ fig = go.Figure(go.Scattermapbox(
))
fig.update_layout(
- mapbox = dict(
- accesstoken=token,
+ map = dict(
style="outdoors", zoom=0.7),
showlegend = False,)
fig.show()
```
+## Mapbox Maps
+
+> Mapbox traces are deprecated and may be removed in a future version of Plotly.py.
+
+The earlier examples using `px.scatter_map` and `go.Scattermap` use [Maplibre](https://maplibre.org/maplibre-gl-js/docs/) for rendering. These traces were introduced in Plotly.py 5.24 and are now the recommended way to create scatter plots on tile-based maps. There are also traces that use [Mapbox](https://docs.mapbox.com): `px.scatter_mapbox` and `go.Scattermapbox`
+
+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.
+
+Here's the first example rewritten to use `px.scatter_mapbox`.
+
+```python
+import plotly.express as px
+px.set_mapbox_access_token(open(".mapbox_token").read())
+df = px.data.carshare()
+fig = px.scatter_mapbox(df, lat="centroid_lat", lon="centroid_lon", color="peak_hour", size="car_hours",
+ color_continuous_scale=px.colors.cyclical.IceFire, size_max=15, zoom=10)
+fig.show()
+
+```
+
+And here's an example using Graph Objects:
+
+```python
+import plotly.graph_objects as go
+
+mapbox_access_token = open(".mapbox_token").read()
+
+fig = go.Figure(go.Scattermapbox(
+ lat=['45.5017'],
+ lon=['-73.5673'],
+ mode='markers',
+ marker=go.scattermapbox.Marker(
+ size=14
+ ),
+ text=['Montreal'],
+ ))
+
+fig.update_layout(
+ hovermode='closest',
+ mapbox=dict(
+ accesstoken=mapbox_access_token,
+ bearing=0,
+ center=go.layout.mapbox.Center(
+ lat=45,
+ lon=-73
+ ),
+ pitch=0,
+ zoom=5
+ )
+)
+
+fig.show()
+```
+
#### Reference
-See [function reference for `px.(scatter_mapbox)`](https://plotly.com/python-api-reference/generated/plotly.express.scatter_mapbox) or https://plotly.com/python/reference/scattermapbox/ for more information and options!
+See [function reference for `px.scatter_map`](https://plotly.com/python-api-reference/generated/plotly.express.scatter_mapbox) or https://plotly.com/python/reference/scattermap/ for more information about the attributes available.
+
+For Mapbox-based tile maps, see [function reference for `px.scatter_mapbox`](https://plotly.com/python-api-reference/generated/plotly.express.scatter_mapbox) or https://plotly.com/python/reference/scattermapbox/.
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 16d08aaa12c..7207dcf8787 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,4 +1,4 @@
-plotly==5.23.0
+plotly==5.24.0
jupytext==1.1.1
ipywidgets==7.7.2
jupyter-client<7
diff --git a/doc/unconverted/python/gapminder-example.md b/doc/unconverted/python/gapminder-example.md
index ef59e82ae4a..427ac4732e8 100644
--- a/doc/unconverted/python/gapminder-example.md
+++ b/doc/unconverted/python/gapminder-example.md
@@ -118,7 +118,7 @@ figure['layout']['plot_bgcolor'] = 'rgb(223, 232, 243)'
For the slider to appear, we need to adda `sliders` dictionary to `layout`. The `sliders` dictionary is set in the following way:
```
-figure['layout']['sliders] = {
+figure['layout']['sliders'] = {
'active': 0,
'yanchor': 'top',
'xanchor': 'left',
diff --git a/doc/unconverted/python/tesla-supercharging-stations.md b/doc/unconverted/python/tesla-supercharging-stations.md
index 28db02a40fd..0d669bc255d 100644
--- a/doc/unconverted/python/tesla-supercharging-stations.md
+++ b/doc/unconverted/python/tesla-supercharging-stations.md
@@ -18,7 +18,7 @@ jupyter:
language: python
layout: base
name: Tesla Supercharging Stations
- order: 10
+ order: 11
page_type: u-guide
permalink: python/tesla-supercharging-stations/
thumbnail: thumbnail/tesla-stations.jpg
diff --git a/packages/javascript/jupyterlab-plotly/package-lock.json b/packages/javascript/jupyterlab-plotly/package-lock.json
index cbedaba1724..24ebeb799f3 100644
--- a/packages/javascript/jupyterlab-plotly/package-lock.json
+++ b/packages/javascript/jupyterlab-plotly/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "jupyterlab-plotly",
- "version": "5.23.0",
+ "version": "5.24.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "jupyterlab-plotly",
- "version": "5.23.0",
+ "version": "5.24.0",
"license": "MIT",
"dependencies": {
"@jupyter-widgets/base": ">=2.0.0 <7.0.0",
@@ -14,7 +14,7 @@
"@lumino/messaging": "^1.2.3",
"@lumino/widgets": "^1.8.1",
"lodash": "^4.17.4",
- "plotly.js": "^2.34.0"
+ "plotly.js": "^2.35.0"
},
"devDependencies": {
"@jupyterlab/builder": "^3.0.0",
@@ -624,6 +624,36 @@
"node": ">=6.0.0"
}
},
+ "node_modules/@maplibre/maplibre-gl-style-spec": {
+ "version": "20.3.1",
+ "resolved": "https://registry.npmjs.org/@maplibre/maplibre-gl-style-spec/-/maplibre-gl-style-spec-20.3.1.tgz",
+ "integrity": "sha512-5ueL4UDitzVtceQ8J4kY+Px3WK+eZTsmGwha3MBKHKqiHvKrjWWwBCIl1K8BuJSc5OFh83uI8IFNoFvQxX2uUw==",
+ "dependencies": {
+ "@mapbox/jsonlint-lines-primitives": "~2.0.2",
+ "@mapbox/unitbezier": "^0.0.1",
+ "json-stringify-pretty-compact": "^4.0.0",
+ "minimist": "^1.2.8",
+ "quickselect": "^2.0.0",
+ "rw": "^1.3.3",
+ "sort-object": "^3.0.3",
+ "tinyqueue": "^3.0.0"
+ },
+ "bin": {
+ "gl-style-format": "dist/gl-style-format.mjs",
+ "gl-style-migrate": "dist/gl-style-migrate.mjs",
+ "gl-style-validate": "dist/gl-style-validate.mjs"
+ }
+ },
+ "node_modules/@maplibre/maplibre-gl-style-spec/node_modules/@mapbox/unitbezier": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/@mapbox/unitbezier/-/unitbezier-0.0.1.tgz",
+ "integrity": "sha512-nMkuDXFv60aBr9soUG5q+GvZYL+2KZHVvsqFCzqnkGEf46U2fvmytHaEVc1/YZbiLn8X+eR3QzX1+dwDO1lxlw=="
+ },
+ "node_modules/@maplibre/maplibre-gl-style-spec/node_modules/tinyqueue": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/tinyqueue/-/tinyqueue-3.0.0.tgz",
+ "integrity": "sha512-gRa9gwYU3ECmQYv3lslts5hxuIa90veaEcxDYuu3QGOIAEM2mOZkVHp48ANJuu1CURtRdHKUBY5Lm1tHV+sD4g=="
+ },
"node_modules/@npmcli/move-file": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/@npmcli/move-file/-/move-file-1.1.2.tgz",
@@ -741,55 +771,86 @@
}
},
"node_modules/@turf/area": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/area/-/area-6.5.0.tgz",
- "integrity": "sha512-xCZdiuojokLbQ+29qR6qoMD89hv+JAgWjLrwSEWL+3JV8IXKeNFl6XkEJz9HGkVpnXvQKJoRz4/liT+8ZZ5Jyg==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/area/-/area-7.1.0.tgz",
+ "integrity": "sha512-w91FEe02/mQfMPRX2pXua48scFuKJ2dSVMF2XmJ6+BJfFiCPxp95I3+Org8+ZsYv93CDNKbf0oLNEPnuQdgs2g==",
"dependencies": {
- "@turf/helpers": "^6.5.0",
- "@turf/meta": "^6.5.0"
+ "@turf/helpers": "^7.1.0",
+ "@turf/meta": "^7.1.0",
+ "@types/geojson": "^7946.0.10",
+ "tslib": "^2.6.2"
},
"funding": {
"url": "https://opencollective.com/turf"
}
},
+ "node_modules/@turf/area/node_modules/tslib": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
+ },
"node_modules/@turf/bbox": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/bbox/-/bbox-6.5.0.tgz",
- "integrity": "sha512-RBbLaao5hXTYyyg577iuMtDB8ehxMlUqHEJiMs8jT1GHkFhr6sYre3lmLsPeYEi/ZKj5TP5tt7fkzNdJ4GIVyw==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/bbox/-/bbox-7.1.0.tgz",
+ "integrity": "sha512-PdWPz9tW86PD78vSZj2fiRaB8JhUHy6piSa/QXb83lucxPK+HTAdzlDQMTKj5okRCU8Ox/25IR2ep9T8NdopRA==",
"dependencies": {
- "@turf/helpers": "^6.5.0",
- "@turf/meta": "^6.5.0"
+ "@turf/helpers": "^7.1.0",
+ "@turf/meta": "^7.1.0",
+ "@types/geojson": "^7946.0.10",
+ "tslib": "^2.6.2"
},
"funding": {
"url": "https://opencollective.com/turf"
}
},
+ "node_modules/@turf/bbox/node_modules/tslib": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
+ },
"node_modules/@turf/centroid": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/centroid/-/centroid-6.5.0.tgz",
- "integrity": "sha512-MwE1oq5E3isewPprEClbfU5pXljIK/GUOMbn22UM3IFPDJX0KeoyLNwghszkdmFp/qMGL/M13MMWvU+GNLXP/A==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/centroid/-/centroid-7.1.0.tgz",
+ "integrity": "sha512-1Y1b2l+ZB1CZ+ITjUCsGqC4/tSjwm/R4OUfDztVqyyCq/VvezkLmTNqvXTGXgfP0GXkpv68iCfxF5M7QdM5pJQ==",
"dependencies": {
- "@turf/helpers": "^6.5.0",
- "@turf/meta": "^6.5.0"
+ "@turf/helpers": "^7.1.0",
+ "@turf/meta": "^7.1.0",
+ "@types/geojson": "^7946.0.10",
+ "tslib": "^2.6.2"
},
"funding": {
"url": "https://opencollective.com/turf"
}
},
+ "node_modules/@turf/centroid/node_modules/tslib": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
+ },
"node_modules/@turf/helpers": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/helpers/-/helpers-6.5.0.tgz",
- "integrity": "sha512-VbI1dV5bLFzohYYdgqwikdMVpe7pJ9X3E+dlr425wa2/sMJqYDhTO++ec38/pcPvPE6oD9WEEeU3Xu3gza+VPw==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/helpers/-/helpers-7.1.0.tgz",
+ "integrity": "sha512-dTeILEUVeNbaEeoZUOhxH5auv7WWlOShbx7QSd4s0T4Z0/iz90z9yaVCtZOLbU89umKotwKaJQltBNO9CzVgaQ==",
+ "dependencies": {
+ "@types/geojson": "^7946.0.10",
+ "tslib": "^2.6.2"
+ },
"funding": {
"url": "https://opencollective.com/turf"
}
},
+ "node_modules/@turf/helpers/node_modules/tslib": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
+ },
"node_modules/@turf/meta": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/meta/-/meta-6.5.0.tgz",
- "integrity": "sha512-RrArvtsV0vdsCBegoBtOalgdSOfkBrTJ07VkpiCnq/491W67hnMWmDu7e6Ztw0C3WldRYTXkg3SumfdzZxLBHA==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/meta/-/meta-7.1.0.tgz",
+ "integrity": "sha512-ZgGpWWiKz797Fe8lfRj7HKCkGR+nSJ/5aKXMyofCvLSc2PuYJs/qyyifDPWjASQQCzseJ7AlF2Pc/XQ/3XkkuA==",
"dependencies": {
- "@turf/helpers": "^6.5.0"
+ "@turf/helpers": "^7.1.0",
+ "@types/geojson": "^7946.0.10"
},
"funding": {
"url": "https://opencollective.com/turf"
@@ -836,6 +897,19 @@
"integrity": "sha512-CuPgU6f3eT/XgKKPqKd/gLZV1Xmvf1a2R5POBOGQa6uv82xpls89HU5zKeVoyR8XzHd1RGNOlQlvUe3CFkjWNQ==",
"dev": true
},
+ "node_modules/@types/geojson": {
+ "version": "7946.0.14",
+ "resolved": "https://registry.npmjs.org/@types/geojson/-/geojson-7946.0.14.tgz",
+ "integrity": "sha512-WCfD5Ht3ZesJUsONdhvm84dmzWOiOzOAqOncN0++w0lBw1o8OuDNJF2McvvCef/yBqb/HYRahp1BYtODFQ8bRg=="
+ },
+ "node_modules/@types/geojson-vt": {
+ "version": "3.2.5",
+ "resolved": "https://registry.npmjs.org/@types/geojson-vt/-/geojson-vt-3.2.5.tgz",
+ "integrity": "sha512-qDO7wqtprzlpe8FfQ//ClPV9xiuoh2nkIgiouIptON9w5jvD/fA4szvP9GBlDVdJ5dldAl0kX/sy3URbWwLx0g==",
+ "dependencies": {
+ "@types/geojson": "*"
+ }
+ },
"node_modules/@types/jquery": {
"version": "3.5.5",
"resolved": "https://registry.npmjs.org/@types/jquery/-/jquery-3.5.5.tgz",
@@ -855,12 +929,32 @@
"resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.168.tgz",
"integrity": "sha512-oVfRvqHV/V6D1yifJbVRU3TMp8OT6o6BG+U9MkwuJ3U8/CsDHvalRpsxBqivn71ztOFZBTfJMvETbqHiaNSj7Q=="
},
+ "node_modules/@types/mapbox__point-geometry": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/@types/mapbox__point-geometry/-/mapbox__point-geometry-0.1.4.tgz",
+ "integrity": "sha512-mUWlSxAmYLfwnRBmgYV86tgYmMIICX4kza8YnE/eIlywGe2XoOxlpVnXWwir92xRLjwyarqwpu2EJKD2pk0IUA=="
+ },
+ "node_modules/@types/mapbox__vector-tile": {
+ "version": "1.3.4",
+ "resolved": "https://registry.npmjs.org/@types/mapbox__vector-tile/-/mapbox__vector-tile-1.3.4.tgz",
+ "integrity": "sha512-bpd8dRn9pr6xKvuEBQup8pwQfD4VUyqO/2deGjfpe6AwC8YRlyEipvefyRJUSiCJTZuCb8Pl1ciVV5ekqJ96Bg==",
+ "dependencies": {
+ "@types/geojson": "*",
+ "@types/mapbox__point-geometry": "*",
+ "@types/pbf": "*"
+ }
+ },
"node_modules/@types/node": {
"version": "14.14.37",
"resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.37.tgz",
"integrity": "sha512-XYmBiy+ohOR4Lh5jE379fV2IU+6Jn4g5qASinhitfyO71b/sCo6MKsMLF5tc7Zf2CE8hViVQyYSobJNke8OvUw==",
"dev": true
},
+ "node_modules/@types/pbf": {
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@types/pbf/-/pbf-3.0.5.tgz",
+ "integrity": "sha512-j3pOPiEcWZ34R6a6mN07mUkM4o4Lwf6hPNt8eilOeZhTFbxFXmKhvXl9Y28jotFPaI1bpPDJsbCprUoNke6OrA=="
+ },
"node_modules/@types/plotly.js": {
"version": "1.54.10",
"resolved": "https://registry.npmjs.org/@types/plotly.js/-/plotly.js-1.54.10.tgz",
@@ -881,6 +975,14 @@
"integrity": "sha512-K5K+yml8LTo9bWJI/rECfIPrGgxdpeNbj+d53lwN4QjW1MCwlkhUms+gtdzigTeUyBr09+u8BwOIY3MXvHdcsA==",
"dev": true
},
+ "node_modules/@types/supercluster": {
+ "version": "7.1.3",
+ "resolved": "https://registry.npmjs.org/@types/supercluster/-/supercluster-7.1.3.tgz",
+ "integrity": "sha512-Z0pOY34GDFl3Q6hUFYf3HkTwKEE02e7QgtJppBt+beEAxnyOpJua+voGFvxINBHa06GwLFFym7gRPY2SiKIfIA==",
+ "dependencies": {
+ "@types/geojson": "*"
+ }
+ },
"node_modules/@types/underscore": {
"version": "1.11.1",
"resolved": "https://registry.npmjs.org/@types/underscore/-/underscore-1.11.1.tgz",
@@ -1182,6 +1284,14 @@
"node": ">=4"
}
},
+ "node_modules/arr-union": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/arr-union/-/arr-union-3.1.0.tgz",
+ "integrity": "sha512-sKpyeERZ02v1FeCZT8lrfJq5u6goHCtpTAzPwJYe7c8SPFOboNjNg1vz2L4VTn9T4PQxEx13TbXLmYUcS6Ug7Q==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/array-bounds": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/array-bounds/-/array-bounds-1.0.1.tgz",
@@ -1213,6 +1323,14 @@
"resolved": "https://registry.npmjs.org/array-rearrange/-/array-rearrange-2.2.2.tgz",
"integrity": "sha512-UfobP5N12Qm4Qu4fwLDIi2v6+wZsSf6snYSxAMeKhrh37YGnNWZPRmVEKc/2wfms53TLQnzfpG8wCx2Y/6NG1w=="
},
+ "node_modules/assign-symbols": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-1.0.0.tgz",
+ "integrity": "sha512-Q+JC7Whu8HhmTdBph/Tq59IoRtoy6KAm5zzPv00WdujX82lbAL8K7WVjne7vdCsAmbF4AYaDOPyO3k0kl8qIrw==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/at-least-node": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
@@ -1362,6 +1480,23 @@
"resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz",
"integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A=="
},
+ "node_modules/bytewise": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/bytewise/-/bytewise-1.1.0.tgz",
+ "integrity": "sha512-rHuuseJ9iQ0na6UDhnrRVDh8YnWVlU6xM3VH6q/+yHDeUH2zIhUzP+2/h3LIrhLDBtTqzWpE3p3tP/boefskKQ==",
+ "dependencies": {
+ "bytewise-core": "^1.2.2",
+ "typewise": "^1.0.3"
+ }
+ },
+ "node_modules/bytewise-core": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/bytewise-core/-/bytewise-core-1.2.3.tgz",
+ "integrity": "sha512-nZD//kc78OOxeYtRlVk8/zXqTB4gf/nlguL1ggWA8FuchMyOxcyHR4QPQZMUmA7czC+YnaBrPUCubqAWe50DaA==",
+ "dependencies": {
+ "typewise-core": "^1.2"
+ }
+ },
"node_modules/cacache": {
"version": "15.0.6",
"resolved": "https://registry.npmjs.org/cacache/-/cacache-15.0.6.tgz",
@@ -2458,6 +2593,17 @@
"resolved": "https://registry.npmjs.org/type/-/type-2.7.2.tgz",
"integrity": "sha512-dzlvlNlt6AXU7EBSfpAscydQ7gXB+pPGsPnfJnZpiNJBDj7IaJzQlBZYGdEi4R9HmPdBv2XmWJ6YUtoTa7lmCw=="
},
+ "node_modules/extend-shallow": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz",
+ "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==",
+ "dependencies": {
+ "is-extendable": "^0.1.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/falafel": {
"version": "2.2.5",
"resolved": "https://registry.npmjs.org/falafel/-/falafel-2.2.5.tgz",
@@ -2691,6 +2837,14 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
+ "node_modules/get-value": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz",
+ "integrity": "sha512-Ln0UQDlxH1BapMu3GPtf7CuYNwRZf2gwCuPqbyG6pB8WfmFpzqcy4xtAaAMUhnNqjMKTiCPZG2oMT3YSx8U2NA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/gl-mat4": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/gl-mat4/-/gl-mat4-1.2.0.tgz",
@@ -2765,6 +2919,41 @@
"integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==",
"dev": true
},
+ "node_modules/global-prefix": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/global-prefix/-/global-prefix-4.0.0.tgz",
+ "integrity": "sha512-w0Uf9Y9/nyHinEk5vMJKRie+wa4kR5hmDbEhGGds/kG1PwGLLHKRoNMeJOyCQjjBkANlnScqgzcFwGHgmgLkVA==",
+ "dependencies": {
+ "ini": "^4.1.3",
+ "kind-of": "^6.0.3",
+ "which": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=16"
+ }
+ },
+ "node_modules/global-prefix/node_modules/isexe": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-3.1.1.tgz",
+ "integrity": "sha512-LpB/54B+/2J5hqQ7imZHfdU31OlgQqx7ZicVlkm9kzg9/w8GKLEcFfJl/t7DCEDueOyBAD6zCCwTO6Fzs0NoEQ==",
+ "engines": {
+ "node": ">=16"
+ }
+ },
+ "node_modules/global-prefix/node_modules/which": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/which/-/which-4.0.0.tgz",
+ "integrity": "sha512-GlaYyEb07DPxYCKhKzplCWBJtvxZcZMrL+4UkrTSJHHPyZU4mYYTv3qaOe77H7EODLSSopAUFAc6W8U4yqvscg==",
+ "dependencies": {
+ "isexe": "^3.1.1"
+ },
+ "bin": {
+ "node-which": "bin/which.js"
+ },
+ "engines": {
+ "node": "^16.13.0 || >=18.0.0"
+ }
+ },
"node_modules/glsl-inject-defines": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/glsl-inject-defines/-/glsl-inject-defines-1.0.3.tgz",
@@ -3136,6 +3325,14 @@
"resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
"integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
},
+ "node_modules/ini": {
+ "version": "4.1.3",
+ "resolved": "https://registry.npmjs.org/ini/-/ini-4.1.3.tgz",
+ "integrity": "sha512-X7rqawQBvfdjS10YU1y1YVreA3SsLrW9dX2CewP2EbBJM4ypVNLDkO5y04gejPwKIY9lR+7r9gn3rFPt/kmWFg==",
+ "engines": {
+ "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+ }
+ },
"node_modules/interpret": {
"version": "2.2.0",
"resolved": "https://registry.npmjs.org/interpret/-/interpret-2.2.0.tgz",
@@ -3215,6 +3412,14 @@
"url": "https://github.com/sponsors/ljharb"
}
},
+ "node_modules/is-extendable": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz",
+ "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/is-finite": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/is-finite/-/is-finite-1.1.0.tgz",
@@ -3300,7 +3505,6 @@
"version": "2.0.4",
"resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz",
"integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==",
- "dev": true,
"dependencies": {
"isobject": "^3.0.1"
},
@@ -3385,7 +3589,6 @@
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
"integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=",
- "dev": true,
"engines": {
"node": ">=0.10.0"
}
@@ -3426,6 +3629,11 @@
"resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
"integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="
},
+ "node_modules/json-stringify-pretty-compact": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/json-stringify-pretty-compact/-/json-stringify-pretty-compact-4.0.0.tgz",
+ "integrity": "sha512-3CNZ2DnrpByG9Nqj6Xo8vqbjT4F6N+tb4Gb28ESAZjYZ5yqvmc56J+/kuIwkaAMOyblTQhUW7PxMkUb8Q36N3Q=="
+ },
"node_modules/json5": {
"version": "2.2.3",
"resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
@@ -3455,7 +3663,6 @@
"version": "6.0.3",
"resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
"integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==",
- "dev": true,
"engines": {
"node": ">=0.10.0"
}
@@ -3644,6 +3851,94 @@
"node": ">=6.4.0"
}
},
+ "node_modules/maplibre-gl": {
+ "version": "4.6.0",
+ "resolved": "https://registry.npmjs.org/maplibre-gl/-/maplibre-gl-4.6.0.tgz",
+ "integrity": "sha512-zobZK+fE+XM+7K81fk5pSBYWZlTGjGT0P96y2fR4DV2ry35ZBfAd0uWNatll69EgYeE+uOhN1MvEk+z1PCuyOQ==",
+ "dependencies": {
+ "@mapbox/geojson-rewind": "^0.5.2",
+ "@mapbox/jsonlint-lines-primitives": "^2.0.2",
+ "@mapbox/point-geometry": "^0.1.0",
+ "@mapbox/tiny-sdf": "^2.0.6",
+ "@mapbox/unitbezier": "^0.0.1",
+ "@mapbox/vector-tile": "^1.3.1",
+ "@mapbox/whoots-js": "^3.1.0",
+ "@maplibre/maplibre-gl-style-spec": "^20.3.1",
+ "@types/geojson": "^7946.0.14",
+ "@types/geojson-vt": "3.2.5",
+ "@types/mapbox__point-geometry": "^0.1.4",
+ "@types/mapbox__vector-tile": "^1.3.4",
+ "@types/pbf": "^3.0.5",
+ "@types/supercluster": "^7.1.3",
+ "earcut": "^3.0.0",
+ "geojson-vt": "^4.0.2",
+ "gl-matrix": "^3.4.3",
+ "global-prefix": "^4.0.0",
+ "kdbush": "^4.0.2",
+ "murmurhash-js": "^1.0.0",
+ "pbf": "^3.3.0",
+ "potpack": "^2.0.0",
+ "quickselect": "^3.0.0",
+ "supercluster": "^8.0.1",
+ "tinyqueue": "^3.0.0",
+ "vt-pbf": "^3.1.3"
+ },
+ "engines": {
+ "node": ">=16.14.0",
+ "npm": ">=8.1.0"
+ },
+ "funding": {
+ "url": "https://github.com/maplibre/maplibre-gl-js?sponsor=1"
+ }
+ },
+ "node_modules/maplibre-gl/node_modules/@mapbox/tiny-sdf": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/@mapbox/tiny-sdf/-/tiny-sdf-2.0.6.tgz",
+ "integrity": "sha512-qMqa27TLw+ZQz5Jk+RcwZGH7BQf5G/TrutJhspsca/3SHwmgKQ1iq+d3Jxz5oysPVYTGP6aXxCo5Lk9Er6YBAA=="
+ },
+ "node_modules/maplibre-gl/node_modules/@mapbox/unitbezier": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/@mapbox/unitbezier/-/unitbezier-0.0.1.tgz",
+ "integrity": "sha512-nMkuDXFv60aBr9soUG5q+GvZYL+2KZHVvsqFCzqnkGEf46U2fvmytHaEVc1/YZbiLn8X+eR3QzX1+dwDO1lxlw=="
+ },
+ "node_modules/maplibre-gl/node_modules/earcut": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/earcut/-/earcut-3.0.0.tgz",
+ "integrity": "sha512-41Fs7Q/PLq1SDbqjsgcY7GA42T0jvaCNGXgGtsNdvg+Yv8eIu06bxv4/PoREkZ9nMDNwnUSG9OFB9+yv8eKhDg=="
+ },
+ "node_modules/maplibre-gl/node_modules/geojson-vt": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/geojson-vt/-/geojson-vt-4.0.2.tgz",
+ "integrity": "sha512-AV9ROqlNqoZEIJGfm1ncNjEXfkz2hdFlZf0qkVfmkwdKa8vj7H16YUOT81rJw1rdFhyEDlN2Tds91p/glzbl5A=="
+ },
+ "node_modules/maplibre-gl/node_modules/kdbush": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/kdbush/-/kdbush-4.0.2.tgz",
+ "integrity": "sha512-WbCVYJ27Sz8zi9Q7Q0xHC+05iwkm3Znipc2XTlrnJbsHMYktW4hPhXUE8Ys1engBrvffoSCqbil1JQAa7clRpA=="
+ },
+ "node_modules/maplibre-gl/node_modules/potpack": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/potpack/-/potpack-2.0.0.tgz",
+ "integrity": "sha512-Q+/tYsFU9r7xoOJ+y/ZTtdVQwTWfzjbiXBDMM/JKUux3+QPP02iUuIoeBQ+Ot6oEDlC+/PGjB/5A3K7KKb7hcw=="
+ },
+ "node_modules/maplibre-gl/node_modules/quickselect": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/quickselect/-/quickselect-3.0.0.tgz",
+ "integrity": "sha512-XdjUArbK4Bm5fLLvlm5KpTFOiOThgfWWI4axAZDWg4E/0mKdZyI9tNEfds27qCi1ze/vwTR16kvmmGhRra3c2g=="
+ },
+ "node_modules/maplibre-gl/node_modules/supercluster": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/supercluster/-/supercluster-8.0.1.tgz",
+ "integrity": "sha512-IiOea5kJ9iqzD2t7QJq/cREyLHTtSmUT6gQsweojg9WH2sYJqZK9SswTu6jrscO6D1G5v5vYZ9ru/eq85lXeZQ==",
+ "dependencies": {
+ "kdbush": "^4.0.2"
+ }
+ },
+ "node_modules/maplibre-gl/node_modules/tinyqueue": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/tinyqueue/-/tinyqueue-3.0.0.tgz",
+ "integrity": "sha512-gRa9gwYU3ECmQYv3lslts5hxuIa90veaEcxDYuu3QGOIAEM2mOZkVHp48ANJuu1CURtRdHKUBY5Lm1tHV+sD4g=="
+ },
"node_modules/math-log2": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/math-log2/-/math-log2-1.0.1.tgz",
@@ -3789,9 +4084,12 @@
}
},
"node_modules/minimist": {
- "version": "1.2.6",
- "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
- "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q=="
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+ "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
},
"node_modules/minipass": {
"version": "3.1.3",
@@ -4305,9 +4603,9 @@
}
},
"node_modules/pbf": {
- "version": "3.2.1",
- "resolved": "https://registry.npmjs.org/pbf/-/pbf-3.2.1.tgz",
- "integrity": "sha512-ClrV7pNOn7rtmoQVF4TS1vyU0WhYRnP92fzbfF75jAIwpnzdJXf8iTd4CMEqO4yUenH6NDqLiwjqlh6QgZzgLQ==",
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/pbf/-/pbf-3.3.0.tgz",
+ "integrity": "sha512-XDF38WCH3z5OV/OVa8GKUNtLAyneuzbCisx7QUCF8Q6Nutx0WnJrQe5O+kOtBlLfRNUws98Y58Lblp+NJG5T4Q==",
"dependencies": {
"ieee754": "^1.1.12",
"resolve-protobuf-schema": "^2.1.0"
@@ -4372,17 +4670,17 @@
}
},
"node_modules/plotly.js": {
- "version": "2.34.0",
- "resolved": "https://registry.npmjs.org/plotly.js/-/plotly.js-2.34.0.tgz",
- "integrity": "sha512-dG2LC6wY6AUR1jsnriBi9xbigLPEEXXOHhLo97dRiZAWZVS6lZCmXXZ227U4rsoluXyfyqQezaKq7svolap8Dw==",
+ "version": "2.35.0",
+ "resolved": "https://registry.npmjs.org/plotly.js/-/plotly.js-2.35.0.tgz",
+ "integrity": "sha512-6PuCd0Lngii/58hOZ1+h9shdf2fTWDelweS3HOWRV9YG2ga/oOmMb0GOsBKLQstiyEeIrVwkIM3RqOCLRtiTcQ==",
"dependencies": {
"@plotly/d3": "3.8.2",
"@plotly/d3-sankey": "0.7.2",
"@plotly/d3-sankey-circular": "0.33.1",
"@plotly/mapbox-gl": "1.13.4",
- "@turf/area": "^6.4.0",
- "@turf/bbox": "^6.4.0",
- "@turf/centroid": "^6.0.2",
+ "@turf/area": "^7.1.0",
+ "@turf/bbox": "^7.1.0",
+ "@turf/centroid": "^7.1.0",
"base64-arraybuffer": "^1.0.2",
"canvas-fit": "^1.5.0",
"color-alpha": "1.0.4",
@@ -4404,13 +4702,14 @@
"has-hover": "^1.0.1",
"has-passive-events": "^1.0.0",
"is-mobile": "^4.0.0",
+ "maplibre-gl": "^4.5.2",
"mouse-change": "^1.4.0",
"mouse-event-offset": "^3.0.2",
"mouse-wheel": "^1.2.0",
"native-promise-only": "^0.8.1",
"parse-svg-path": "^0.1.2",
"point-in-polygon": "^1.1.0",
- "polybooljs": "^1.2.0",
+ "polybooljs": "^1.2.2",
"probe-image-size": "^7.2.3",
"regl": "npm:@plotly/regl@^2.1.2",
"regl-error2d": "^2.0.12",
@@ -4441,9 +4740,9 @@
"integrity": "sha512-3ojrFwjnnw8Q9242TzgXuTD+eKiutbzyslcq1ydfu82Db2y+Ogbmyrkpv0Hgj31qwT3lbS9+QAAO/pIQM35XRw=="
},
"node_modules/polybooljs": {
- "version": "1.2.0",
- "resolved": "https://registry.npmjs.org/polybooljs/-/polybooljs-1.2.0.tgz",
- "integrity": "sha512-mKjR5nolISvF+q2BtC1fi/llpxBPTQ3wLWN8+ldzdw2Hocpc8C72ZqnamCM4Z6z+68GVVjkeM01WJegQmZ8MEQ=="
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/polybooljs/-/polybooljs-1.2.2.tgz",
+ "integrity": "sha512-ziHW/02J0XuNuUtmidBc6GXE8YohYydp3DWPWXYsd7O721TjcmN+k6ezjdwkDqep+gnWnFY+yqZHvzElra2oCg=="
},
"node_modules/postcss": {
"version": "8.3.2",
@@ -4953,6 +5252,20 @@
"randombytes": "^2.1.0"
}
},
+ "node_modules/set-value": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz",
+ "integrity": "sha512-JxHc1weCN68wRY0fhCoXpyK55m/XPHafOmK4UWD7m2CI14GMcFypt4w/0+NV5f/ZMby2F6S2wwA7fgynh9gWSw==",
+ "dependencies": {
+ "extend-shallow": "^2.0.1",
+ "is-extendable": "^0.1.1",
+ "is-plain-object": "^2.0.3",
+ "split-string": "^3.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/shallow-clone": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz",
@@ -5008,6 +5321,38 @@
"resolved": "https://registry.npmjs.org/signum/-/signum-1.0.0.tgz",
"integrity": "sha512-yodFGwcyt59XRh7w5W3jPcIQb3Bwi21suEfT7MAWnBX3iCdklJpgDgvGT9o04UonglZN5SNMfJFkHIR/jO8GHw=="
},
+ "node_modules/sort-asc": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/sort-asc/-/sort-asc-0.2.0.tgz",
+ "integrity": "sha512-umMGhjPeHAI6YjABoSTrFp2zaBtXBej1a0yKkuMUyjjqu6FJsTF+JYwCswWDg+zJfk/5npWUUbd33HH/WLzpaA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/sort-desc": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/sort-desc/-/sort-desc-0.2.0.tgz",
+ "integrity": "sha512-NqZqyvL4VPW+RAxxXnB8gvE1kyikh8+pR+T+CXLksVRN9eiQqkQlPwqWYU0mF9Jm7UnctShlxLyAt1CaBOTL1w==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/sort-object": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/sort-object/-/sort-object-3.0.3.tgz",
+ "integrity": "sha512-nK7WOY8jik6zaG9CRwZTaD5O7ETWDLZYMM12pqY8htll+7dYeqGfEUPcUBHOpSJg2vJOrvFIY2Dl5cX2ih1hAQ==",
+ "dependencies": {
+ "bytewise": "^1.1.0",
+ "get-value": "^2.0.2",
+ "is-extendable": "^0.1.1",
+ "sort-asc": "^0.2.0",
+ "sort-desc": "^0.2.0",
+ "union-value": "^1.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/source-list-map": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/source-list-map/-/source-list-map-2.0.1.tgz",
@@ -5132,6 +5477,40 @@
"integrity": "sha512-J+FWzZoynJEXGphVIS+XEh3kFSjZX/1i9gFBaWQcB+/tmpe2qUsSBABpcxqxnAxFdiUFEgAX1bjYGQvIZmoz9Q==",
"dev": true
},
+ "node_modules/split-string": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/split-string/-/split-string-3.1.0.tgz",
+ "integrity": "sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==",
+ "dependencies": {
+ "extend-shallow": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/split-string/node_modules/extend-shallow": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-3.0.2.tgz",
+ "integrity": "sha512-BwY5b5Ql4+qZoefgMj2NUmx+tehVTH/Kf4k1ZEtOHNFcm2wSxMRo992l6X3TIgni2eZVTZ85xMOjF31fwZAj6Q==",
+ "dependencies": {
+ "assign-symbols": "^1.0.0",
+ "is-extendable": "^1.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/split-string/node_modules/is-extendable": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz",
+ "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==",
+ "dependencies": {
+ "is-plain-object": "^2.0.4"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/ssri": {
"version": "8.0.1",
"resolved": "https://registry.npmjs.org/ssri/-/ssri-8.0.1.tgz",
@@ -5741,6 +6120,19 @@
"node": ">=4.2.0"
}
},
+ "node_modules/typewise": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/typewise/-/typewise-1.0.3.tgz",
+ "integrity": "sha512-aXofE06xGhaQSPzt8hlTY+/YWQhm9P0jYUp1f2XtmW/3Bk0qzXcyFWAtPoo2uTGQj1ZwbDuSyuxicq+aDo8lCQ==",
+ "dependencies": {
+ "typewise-core": "^1.2.0"
+ }
+ },
+ "node_modules/typewise-core": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/typewise-core/-/typewise-core-1.2.0.tgz",
+ "integrity": "sha512-2SCC/WLzj2SbUwzFOzqMCkz5amXLlxtJqDKTICqg30x+2DZxcfZN2MvQZmGfXWKNWaKK9pBPsvkcwv8bF/gxKg=="
+ },
"node_modules/unbox-primitive": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz",
@@ -5761,6 +6153,20 @@
"resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz",
"integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw=="
},
+ "node_modules/union-value": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz",
+ "integrity": "sha512-tJfXmxMeWYnczCVs7XAEvIV7ieppALdyepWMkHkwciRpZraG/xwT+s2JN8+pr1+8jCRf80FFzvr+MpQeeoF4Xg==",
+ "dependencies": {
+ "arr-union": "^3.1.0",
+ "get-value": "^2.0.6",
+ "is-extendable": "^0.1.1",
+ "set-value": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
"node_modules/uniq": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/uniq/-/uniq-1.0.1.tgz",
@@ -6888,6 +7294,33 @@
"resolved": "https://registry.npmjs.org/@mapbox/whoots-js/-/whoots-js-3.1.0.tgz",
"integrity": "sha512-Es6WcD0nO5l+2BOQS4uLfNPYQaNDfbot3X1XUoloz+x0mPDS3eeORZJl06HXjwBG1fOGwCRnzK88LMdxKRrd6Q=="
},
+ "@maplibre/maplibre-gl-style-spec": {
+ "version": "20.3.1",
+ "resolved": "https://registry.npmjs.org/@maplibre/maplibre-gl-style-spec/-/maplibre-gl-style-spec-20.3.1.tgz",
+ "integrity": "sha512-5ueL4UDitzVtceQ8J4kY+Px3WK+eZTsmGwha3MBKHKqiHvKrjWWwBCIl1K8BuJSc5OFh83uI8IFNoFvQxX2uUw==",
+ "requires": {
+ "@mapbox/jsonlint-lines-primitives": "~2.0.2",
+ "@mapbox/unitbezier": "^0.0.1",
+ "json-stringify-pretty-compact": "^4.0.0",
+ "minimist": "^1.2.8",
+ "quickselect": "^2.0.0",
+ "rw": "^1.3.3",
+ "sort-object": "^3.0.3",
+ "tinyqueue": "^3.0.0"
+ },
+ "dependencies": {
+ "@mapbox/unitbezier": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/@mapbox/unitbezier/-/unitbezier-0.0.1.tgz",
+ "integrity": "sha512-nMkuDXFv60aBr9soUG5q+GvZYL+2KZHVvsqFCzqnkGEf46U2fvmytHaEVc1/YZbiLn8X+eR3QzX1+dwDO1lxlw=="
+ },
+ "tinyqueue": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/tinyqueue/-/tinyqueue-3.0.0.tgz",
+ "integrity": "sha512-gRa9gwYU3ECmQYv3lslts5hxuIa90veaEcxDYuu3QGOIAEM2mOZkVHp48ANJuu1CURtRdHKUBY5Lm1tHV+sD4g=="
+ }
+ }
+ },
"@npmcli/move-file": {
"version": "1.1.2",
"resolved": "https://registry.npmjs.org/@npmcli/move-file/-/move-file-1.1.2.tgz",
@@ -6988,43 +7421,82 @@
}
},
"@turf/area": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/area/-/area-6.5.0.tgz",
- "integrity": "sha512-xCZdiuojokLbQ+29qR6qoMD89hv+JAgWjLrwSEWL+3JV8IXKeNFl6XkEJz9HGkVpnXvQKJoRz4/liT+8ZZ5Jyg==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/area/-/area-7.1.0.tgz",
+ "integrity": "sha512-w91FEe02/mQfMPRX2pXua48scFuKJ2dSVMF2XmJ6+BJfFiCPxp95I3+Org8+ZsYv93CDNKbf0oLNEPnuQdgs2g==",
"requires": {
- "@turf/helpers": "^6.5.0",
- "@turf/meta": "^6.5.0"
+ "@turf/helpers": "^7.1.0",
+ "@turf/meta": "^7.1.0",
+ "@types/geojson": "^7946.0.10",
+ "tslib": "^2.6.2"
+ },
+ "dependencies": {
+ "tslib": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
+ }
}
},
"@turf/bbox": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/bbox/-/bbox-6.5.0.tgz",
- "integrity": "sha512-RBbLaao5hXTYyyg577iuMtDB8ehxMlUqHEJiMs8jT1GHkFhr6sYre3lmLsPeYEi/ZKj5TP5tt7fkzNdJ4GIVyw==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/bbox/-/bbox-7.1.0.tgz",
+ "integrity": "sha512-PdWPz9tW86PD78vSZj2fiRaB8JhUHy6piSa/QXb83lucxPK+HTAdzlDQMTKj5okRCU8Ox/25IR2ep9T8NdopRA==",
"requires": {
- "@turf/helpers": "^6.5.0",
- "@turf/meta": "^6.5.0"
+ "@turf/helpers": "^7.1.0",
+ "@turf/meta": "^7.1.0",
+ "@types/geojson": "^7946.0.10",
+ "tslib": "^2.6.2"
+ },
+ "dependencies": {
+ "tslib": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
+ }
}
},
"@turf/centroid": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/centroid/-/centroid-6.5.0.tgz",
- "integrity": "sha512-MwE1oq5E3isewPprEClbfU5pXljIK/GUOMbn22UM3IFPDJX0KeoyLNwghszkdmFp/qMGL/M13MMWvU+GNLXP/A==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/centroid/-/centroid-7.1.0.tgz",
+ "integrity": "sha512-1Y1b2l+ZB1CZ+ITjUCsGqC4/tSjwm/R4OUfDztVqyyCq/VvezkLmTNqvXTGXgfP0GXkpv68iCfxF5M7QdM5pJQ==",
"requires": {
- "@turf/helpers": "^6.5.0",
- "@turf/meta": "^6.5.0"
+ "@turf/helpers": "^7.1.0",
+ "@turf/meta": "^7.1.0",
+ "@types/geojson": "^7946.0.10",
+ "tslib": "^2.6.2"
+ },
+ "dependencies": {
+ "tslib": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
+ }
}
},
"@turf/helpers": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/helpers/-/helpers-6.5.0.tgz",
- "integrity": "sha512-VbI1dV5bLFzohYYdgqwikdMVpe7pJ9X3E+dlr425wa2/sMJqYDhTO++ec38/pcPvPE6oD9WEEeU3Xu3gza+VPw=="
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/helpers/-/helpers-7.1.0.tgz",
+ "integrity": "sha512-dTeILEUVeNbaEeoZUOhxH5auv7WWlOShbx7QSd4s0T4Z0/iz90z9yaVCtZOLbU89umKotwKaJQltBNO9CzVgaQ==",
+ "requires": {
+ "@types/geojson": "^7946.0.10",
+ "tslib": "^2.6.2"
+ },
+ "dependencies": {
+ "tslib": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz",
+ "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA=="
+ }
+ }
},
"@turf/meta": {
- "version": "6.5.0",
- "resolved": "https://registry.npmjs.org/@turf/meta/-/meta-6.5.0.tgz",
- "integrity": "sha512-RrArvtsV0vdsCBegoBtOalgdSOfkBrTJ07VkpiCnq/491W67hnMWmDu7e6Ztw0C3WldRYTXkg3SumfdzZxLBHA==",
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/@turf/meta/-/meta-7.1.0.tgz",
+ "integrity": "sha512-ZgGpWWiKz797Fe8lfRj7HKCkGR+nSJ/5aKXMyofCvLSc2PuYJs/qyyifDPWjASQQCzseJ7AlF2Pc/XQ/3XkkuA==",
"requires": {
- "@turf/helpers": "^6.5.0"
+ "@turf/helpers": "^7.1.0",
+ "@types/geojson": "^7946.0.10"
}
},
"@types/backbone": {
@@ -7068,6 +7540,19 @@
"integrity": "sha512-CuPgU6f3eT/XgKKPqKd/gLZV1Xmvf1a2R5POBOGQa6uv82xpls89HU5zKeVoyR8XzHd1RGNOlQlvUe3CFkjWNQ==",
"dev": true
},
+ "@types/geojson": {
+ "version": "7946.0.14",
+ "resolved": "https://registry.npmjs.org/@types/geojson/-/geojson-7946.0.14.tgz",
+ "integrity": "sha512-WCfD5Ht3ZesJUsONdhvm84dmzWOiOzOAqOncN0++w0lBw1o8OuDNJF2McvvCef/yBqb/HYRahp1BYtODFQ8bRg=="
+ },
+ "@types/geojson-vt": {
+ "version": "3.2.5",
+ "resolved": "https://registry.npmjs.org/@types/geojson-vt/-/geojson-vt-3.2.5.tgz",
+ "integrity": "sha512-qDO7wqtprzlpe8FfQ//ClPV9xiuoh2nkIgiouIptON9w5jvD/fA4szvP9GBlDVdJ5dldAl0kX/sy3URbWwLx0g==",
+ "requires": {
+ "@types/geojson": "*"
+ }
+ },
"@types/jquery": {
"version": "3.5.5",
"resolved": "https://registry.npmjs.org/@types/jquery/-/jquery-3.5.5.tgz",
@@ -7087,12 +7572,32 @@
"resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.168.tgz",
"integrity": "sha512-oVfRvqHV/V6D1yifJbVRU3TMp8OT6o6BG+U9MkwuJ3U8/CsDHvalRpsxBqivn71ztOFZBTfJMvETbqHiaNSj7Q=="
},
+ "@types/mapbox__point-geometry": {
+ "version": "0.1.4",
+ "resolved": "https://registry.npmjs.org/@types/mapbox__point-geometry/-/mapbox__point-geometry-0.1.4.tgz",
+ "integrity": "sha512-mUWlSxAmYLfwnRBmgYV86tgYmMIICX4kza8YnE/eIlywGe2XoOxlpVnXWwir92xRLjwyarqwpu2EJKD2pk0IUA=="
+ },
+ "@types/mapbox__vector-tile": {
+ "version": "1.3.4",
+ "resolved": "https://registry.npmjs.org/@types/mapbox__vector-tile/-/mapbox__vector-tile-1.3.4.tgz",
+ "integrity": "sha512-bpd8dRn9pr6xKvuEBQup8pwQfD4VUyqO/2deGjfpe6AwC8YRlyEipvefyRJUSiCJTZuCb8Pl1ciVV5ekqJ96Bg==",
+ "requires": {
+ "@types/geojson": "*",
+ "@types/mapbox__point-geometry": "*",
+ "@types/pbf": "*"
+ }
+ },
"@types/node": {
"version": "14.14.37",
"resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.37.tgz",
"integrity": "sha512-XYmBiy+ohOR4Lh5jE379fV2IU+6Jn4g5qASinhitfyO71b/sCo6MKsMLF5tc7Zf2CE8hViVQyYSobJNke8OvUw==",
"dev": true
},
+ "@types/pbf": {
+ "version": "3.0.5",
+ "resolved": "https://registry.npmjs.org/@types/pbf/-/pbf-3.0.5.tgz",
+ "integrity": "sha512-j3pOPiEcWZ34R6a6mN07mUkM4o4Lwf6hPNt8eilOeZhTFbxFXmKhvXl9Y28jotFPaI1bpPDJsbCprUoNke6OrA=="
+ },
"@types/plotly.js": {
"version": "1.54.10",
"resolved": "https://registry.npmjs.org/@types/plotly.js/-/plotly.js-1.54.10.tgz",
@@ -7113,6 +7618,14 @@
"integrity": "sha512-K5K+yml8LTo9bWJI/rECfIPrGgxdpeNbj+d53lwN4QjW1MCwlkhUms+gtdzigTeUyBr09+u8BwOIY3MXvHdcsA==",
"dev": true
},
+ "@types/supercluster": {
+ "version": "7.1.3",
+ "resolved": "https://registry.npmjs.org/@types/supercluster/-/supercluster-7.1.3.tgz",
+ "integrity": "sha512-Z0pOY34GDFl3Q6hUFYf3HkTwKEE02e7QgtJppBt+beEAxnyOpJua+voGFvxINBHa06GwLFFym7gRPY2SiKIfIA==",
+ "requires": {
+ "@types/geojson": "*"
+ }
+ },
"@types/underscore": {
"version": "1.11.1",
"resolved": "https://registry.npmjs.org/@types/underscore/-/underscore-1.11.1.tgz",
@@ -7380,6 +7893,11 @@
"color-convert": "^1.9.0"
}
},
+ "arr-union": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/arr-union/-/arr-union-3.1.0.tgz",
+ "integrity": "sha512-sKpyeERZ02v1FeCZT8lrfJq5u6goHCtpTAzPwJYe7c8SPFOboNjNg1vz2L4VTn9T4PQxEx13TbXLmYUcS6Ug7Q=="
+ },
"array-bounds": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/array-bounds/-/array-bounds-1.0.1.tgz",
@@ -7408,6 +7926,11 @@
"resolved": "https://registry.npmjs.org/array-rearrange/-/array-rearrange-2.2.2.tgz",
"integrity": "sha512-UfobP5N12Qm4Qu4fwLDIi2v6+wZsSf6snYSxAMeKhrh37YGnNWZPRmVEKc/2wfms53TLQnzfpG8wCx2Y/6NG1w=="
},
+ "assign-symbols": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-1.0.0.tgz",
+ "integrity": "sha512-Q+JC7Whu8HhmTdBph/Tq59IoRtoy6KAm5zzPv00WdujX82lbAL8K7WVjne7vdCsAmbF4AYaDOPyO3k0kl8qIrw=="
+ },
"at-least-node": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
@@ -7519,6 +8042,23 @@
"resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz",
"integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A=="
},
+ "bytewise": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/bytewise/-/bytewise-1.1.0.tgz",
+ "integrity": "sha512-rHuuseJ9iQ0na6UDhnrRVDh8YnWVlU6xM3VH6q/+yHDeUH2zIhUzP+2/h3LIrhLDBtTqzWpE3p3tP/boefskKQ==",
+ "requires": {
+ "bytewise-core": "^1.2.2",
+ "typewise": "^1.0.3"
+ }
+ },
+ "bytewise-core": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/bytewise-core/-/bytewise-core-1.2.3.tgz",
+ "integrity": "sha512-nZD//kc78OOxeYtRlVk8/zXqTB4gf/nlguL1ggWA8FuchMyOxcyHR4QPQZMUmA7czC+YnaBrPUCubqAWe50DaA==",
+ "requires": {
+ "typewise-core": "^1.2"
+ }
+ },
"cacache": {
"version": "15.0.6",
"resolved": "https://registry.npmjs.org/cacache/-/cacache-15.0.6.tgz",
@@ -8421,6 +8961,14 @@
}
}
},
+ "extend-shallow": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz",
+ "integrity": "sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==",
+ "requires": {
+ "is-extendable": "^0.1.0"
+ }
+ },
"falafel": {
"version": "2.2.5",
"resolved": "https://registry.npmjs.org/falafel/-/falafel-2.2.5.tgz",
@@ -8615,6 +9163,11 @@
"resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz",
"integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg=="
},
+ "get-value": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz",
+ "integrity": "sha512-Ln0UQDlxH1BapMu3GPtf7CuYNwRZf2gwCuPqbyG6pB8WfmFpzqcy4xtAaAMUhnNqjMKTiCPZG2oMT3YSx8U2NA=="
+ },
"gl-mat4": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/gl-mat4/-/gl-mat4-1.2.0.tgz",
@@ -8683,6 +9236,31 @@
"integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==",
"dev": true
},
+ "global-prefix": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/global-prefix/-/global-prefix-4.0.0.tgz",
+ "integrity": "sha512-w0Uf9Y9/nyHinEk5vMJKRie+wa4kR5hmDbEhGGds/kG1PwGLLHKRoNMeJOyCQjjBkANlnScqgzcFwGHgmgLkVA==",
+ "requires": {
+ "ini": "^4.1.3",
+ "kind-of": "^6.0.3",
+ "which": "^4.0.0"
+ },
+ "dependencies": {
+ "isexe": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-3.1.1.tgz",
+ "integrity": "sha512-LpB/54B+/2J5hqQ7imZHfdU31OlgQqx7ZicVlkm9kzg9/w8GKLEcFfJl/t7DCEDueOyBAD6zCCwTO6Fzs0NoEQ=="
+ },
+ "which": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/which/-/which-4.0.0.tgz",
+ "integrity": "sha512-GlaYyEb07DPxYCKhKzplCWBJtvxZcZMrL+4UkrTSJHHPyZU4mYYTv3qaOe77H7EODLSSopAUFAc6W8U4yqvscg==",
+ "requires": {
+ "isexe": "^3.1.1"
+ }
+ }
+ }
+ },
"glsl-inject-defines": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/glsl-inject-defines/-/glsl-inject-defines-1.0.3.tgz",
@@ -9000,6 +9578,11 @@
"resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
"integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="
},
+ "ini": {
+ "version": "4.1.3",
+ "resolved": "https://registry.npmjs.org/ini/-/ini-4.1.3.tgz",
+ "integrity": "sha512-X7rqawQBvfdjS10YU1y1YVreA3SsLrW9dX2CewP2EbBJM4ypVNLDkO5y04gejPwKIY9lR+7r9gn3rFPt/kmWFg=="
+ },
"interpret": {
"version": "2.2.0",
"resolved": "https://registry.npmjs.org/interpret/-/interpret-2.2.0.tgz",
@@ -9052,6 +9635,11 @@
"integrity": "sha512-USlDT524woQ08aoZFzh3/Z6ch9Y/EWXEHQ/AaRN0SkKq4t2Jw2R2339tSXmwuVoY7LLlBCbOIlx2myP/L5zk0g==",
"dev": true
},
+ "is-extendable": {
+ "version": "0.1.1",
+ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz",
+ "integrity": "sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw=="
+ },
"is-finite": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/is-finite/-/is-finite-1.1.0.tgz",
@@ -9104,7 +9692,6 @@
"version": "2.0.4",
"resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz",
"integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==",
- "dev": true,
"requires": {
"isobject": "^3.0.1"
}
@@ -9164,8 +9751,7 @@
"isobject": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz",
- "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8=",
- "dev": true
+ "integrity": "sha1-TkMekrEalzFjaqH5yNHMvP2reN8="
},
"jest-worker": {
"version": "26.6.2",
@@ -9200,6 +9786,11 @@
"resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
"integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg=="
},
+ "json-stringify-pretty-compact": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/json-stringify-pretty-compact/-/json-stringify-pretty-compact-4.0.0.tgz",
+ "integrity": "sha512-3CNZ2DnrpByG9Nqj6Xo8vqbjT4F6N+tb4Gb28ESAZjYZ5yqvmc56J+/kuIwkaAMOyblTQhUW7PxMkUb8Q36N3Q=="
+ },
"json5": {
"version": "2.2.3",
"resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz",
@@ -9222,8 +9813,7 @@
"kind-of": {
"version": "6.0.3",
"resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz",
- "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==",
- "dev": true
+ "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw=="
},
"levn": {
"version": "0.3.0",
@@ -9377,6 +9967,89 @@
"vt-pbf": "^3.1.1"
}
},
+ "maplibre-gl": {
+ "version": "4.6.0",
+ "resolved": "https://registry.npmjs.org/maplibre-gl/-/maplibre-gl-4.6.0.tgz",
+ "integrity": "sha512-zobZK+fE+XM+7K81fk5pSBYWZlTGjGT0P96y2fR4DV2ry35ZBfAd0uWNatll69EgYeE+uOhN1MvEk+z1PCuyOQ==",
+ "requires": {
+ "@mapbox/geojson-rewind": "^0.5.2",
+ "@mapbox/jsonlint-lines-primitives": "^2.0.2",
+ "@mapbox/point-geometry": "^0.1.0",
+ "@mapbox/tiny-sdf": "^2.0.6",
+ "@mapbox/unitbezier": "^0.0.1",
+ "@mapbox/vector-tile": "^1.3.1",
+ "@mapbox/whoots-js": "^3.1.0",
+ "@maplibre/maplibre-gl-style-spec": "^20.3.1",
+ "@types/geojson": "^7946.0.14",
+ "@types/geojson-vt": "3.2.5",
+ "@types/mapbox__point-geometry": "^0.1.4",
+ "@types/mapbox__vector-tile": "^1.3.4",
+ "@types/pbf": "^3.0.5",
+ "@types/supercluster": "^7.1.3",
+ "earcut": "^3.0.0",
+ "geojson-vt": "^4.0.2",
+ "gl-matrix": "^3.4.3",
+ "global-prefix": "^4.0.0",
+ "kdbush": "^4.0.2",
+ "murmurhash-js": "^1.0.0",
+ "pbf": "^3.3.0",
+ "potpack": "^2.0.0",
+ "quickselect": "^3.0.0",
+ "supercluster": "^8.0.1",
+ "tinyqueue": "^3.0.0",
+ "vt-pbf": "^3.1.3"
+ },
+ "dependencies": {
+ "@mapbox/tiny-sdf": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/@mapbox/tiny-sdf/-/tiny-sdf-2.0.6.tgz",
+ "integrity": "sha512-qMqa27TLw+ZQz5Jk+RcwZGH7BQf5G/TrutJhspsca/3SHwmgKQ1iq+d3Jxz5oysPVYTGP6aXxCo5Lk9Er6YBAA=="
+ },
+ "@mapbox/unitbezier": {
+ "version": "0.0.1",
+ "resolved": "https://registry.npmjs.org/@mapbox/unitbezier/-/unitbezier-0.0.1.tgz",
+ "integrity": "sha512-nMkuDXFv60aBr9soUG5q+GvZYL+2KZHVvsqFCzqnkGEf46U2fvmytHaEVc1/YZbiLn8X+eR3QzX1+dwDO1lxlw=="
+ },
+ "earcut": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/earcut/-/earcut-3.0.0.tgz",
+ "integrity": "sha512-41Fs7Q/PLq1SDbqjsgcY7GA42T0jvaCNGXgGtsNdvg+Yv8eIu06bxv4/PoREkZ9nMDNwnUSG9OFB9+yv8eKhDg=="
+ },
+ "geojson-vt": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/geojson-vt/-/geojson-vt-4.0.2.tgz",
+ "integrity": "sha512-AV9ROqlNqoZEIJGfm1ncNjEXfkz2hdFlZf0qkVfmkwdKa8vj7H16YUOT81rJw1rdFhyEDlN2Tds91p/glzbl5A=="
+ },
+ "kdbush": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/kdbush/-/kdbush-4.0.2.tgz",
+ "integrity": "sha512-WbCVYJ27Sz8zi9Q7Q0xHC+05iwkm3Znipc2XTlrnJbsHMYktW4hPhXUE8Ys1engBrvffoSCqbil1JQAa7clRpA=="
+ },
+ "potpack": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/potpack/-/potpack-2.0.0.tgz",
+ "integrity": "sha512-Q+/tYsFU9r7xoOJ+y/ZTtdVQwTWfzjbiXBDMM/JKUux3+QPP02iUuIoeBQ+Ot6oEDlC+/PGjB/5A3K7KKb7hcw=="
+ },
+ "quickselect": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/quickselect/-/quickselect-3.0.0.tgz",
+ "integrity": "sha512-XdjUArbK4Bm5fLLvlm5KpTFOiOThgfWWI4axAZDWg4E/0mKdZyI9tNEfds27qCi1ze/vwTR16kvmmGhRra3c2g=="
+ },
+ "supercluster": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/supercluster/-/supercluster-8.0.1.tgz",
+ "integrity": "sha512-IiOea5kJ9iqzD2t7QJq/cREyLHTtSmUT6gQsweojg9WH2sYJqZK9SswTu6jrscO6D1G5v5vYZ9ru/eq85lXeZQ==",
+ "requires": {
+ "kdbush": "^4.0.2"
+ }
+ },
+ "tinyqueue": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/tinyqueue/-/tinyqueue-3.0.0.tgz",
+ "integrity": "sha512-gRa9gwYU3ECmQYv3lslts5hxuIa90veaEcxDYuu3QGOIAEM2mOZkVHp48ANJuu1CURtRdHKUBY5Lm1tHV+sD4g=="
+ }
+ }
+ },
"math-log2": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/math-log2/-/math-log2-1.0.1.tgz",
@@ -9480,9 +10153,9 @@
}
},
"minimist": {
- "version": "1.2.6",
- "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
- "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q=="
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+ "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA=="
},
"minipass": {
"version": "3.1.3",
@@ -9875,9 +10548,9 @@
}
},
"pbf": {
- "version": "3.2.1",
- "resolved": "https://registry.npmjs.org/pbf/-/pbf-3.2.1.tgz",
- "integrity": "sha512-ClrV7pNOn7rtmoQVF4TS1vyU0WhYRnP92fzbfF75jAIwpnzdJXf8iTd4CMEqO4yUenH6NDqLiwjqlh6QgZzgLQ==",
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/pbf/-/pbf-3.3.0.tgz",
+ "integrity": "sha512-XDF38WCH3z5OV/OVa8GKUNtLAyneuzbCisx7QUCF8Q6Nutx0WnJrQe5O+kOtBlLfRNUws98Y58Lblp+NJG5T4Q==",
"requires": {
"ieee754": "^1.1.12",
"resolve-protobuf-schema": "^2.1.0"
@@ -9921,17 +10594,17 @@
}
},
"plotly.js": {
- "version": "2.34.0",
- "resolved": "https://registry.npmjs.org/plotly.js/-/plotly.js-2.34.0.tgz",
- "integrity": "sha512-dG2LC6wY6AUR1jsnriBi9xbigLPEEXXOHhLo97dRiZAWZVS6lZCmXXZ227U4rsoluXyfyqQezaKq7svolap8Dw==",
+ "version": "2.35.0",
+ "resolved": "https://registry.npmjs.org/plotly.js/-/plotly.js-2.35.0.tgz",
+ "integrity": "sha512-6PuCd0Lngii/58hOZ1+h9shdf2fTWDelweS3HOWRV9YG2ga/oOmMb0GOsBKLQstiyEeIrVwkIM3RqOCLRtiTcQ==",
"requires": {
"@plotly/d3": "3.8.2",
"@plotly/d3-sankey": "0.7.2",
"@plotly/d3-sankey-circular": "0.33.1",
"@plotly/mapbox-gl": "1.13.4",
- "@turf/area": "^6.4.0",
- "@turf/bbox": "^6.4.0",
- "@turf/centroid": "^6.0.2",
+ "@turf/area": "^7.1.0",
+ "@turf/bbox": "^7.1.0",
+ "@turf/centroid": "^7.1.0",
"base64-arraybuffer": "^1.0.2",
"canvas-fit": "^1.5.0",
"color-alpha": "1.0.4",
@@ -9953,13 +10626,14 @@
"has-hover": "^1.0.1",
"has-passive-events": "^1.0.0",
"is-mobile": "^4.0.0",
+ "maplibre-gl": "^4.5.2",
"mouse-change": "^1.4.0",
"mouse-event-offset": "^3.0.2",
"mouse-wheel": "^1.2.0",
"native-promise-only": "^0.8.1",
"parse-svg-path": "^0.1.2",
"point-in-polygon": "^1.1.0",
- "polybooljs": "^1.2.0",
+ "polybooljs": "^1.2.2",
"probe-image-size": "^7.2.3",
"regl": "npm:@plotly/regl@^2.1.2",
"regl-error2d": "^2.0.12",
@@ -9992,9 +10666,9 @@
"integrity": "sha512-3ojrFwjnnw8Q9242TzgXuTD+eKiutbzyslcq1ydfu82Db2y+Ogbmyrkpv0Hgj31qwT3lbS9+QAAO/pIQM35XRw=="
},
"polybooljs": {
- "version": "1.2.0",
- "resolved": "https://registry.npmjs.org/polybooljs/-/polybooljs-1.2.0.tgz",
- "integrity": "sha512-mKjR5nolISvF+q2BtC1fi/llpxBPTQ3wLWN8+ldzdw2Hocpc8C72ZqnamCM4Z6z+68GVVjkeM01WJegQmZ8MEQ=="
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/polybooljs/-/polybooljs-1.2.2.tgz",
+ "integrity": "sha512-ziHW/02J0XuNuUtmidBc6GXE8YohYydp3DWPWXYsd7O721TjcmN+k6ezjdwkDqep+gnWnFY+yqZHvzElra2oCg=="
},
"postcss": {
"version": "8.3.2",
@@ -10394,6 +11068,17 @@
"randombytes": "^2.1.0"
}
},
+ "set-value": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/set-value/-/set-value-2.0.1.tgz",
+ "integrity": "sha512-JxHc1weCN68wRY0fhCoXpyK55m/XPHafOmK4UWD7m2CI14GMcFypt4w/0+NV5f/ZMby2F6S2wwA7fgynh9gWSw==",
+ "requires": {
+ "extend-shallow": "^2.0.1",
+ "is-extendable": "^0.1.1",
+ "is-plain-object": "^2.0.3",
+ "split-string": "^3.0.1"
+ }
+ },
"shallow-clone": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz",
@@ -10440,6 +11125,29 @@
"resolved": "https://registry.npmjs.org/signum/-/signum-1.0.0.tgz",
"integrity": "sha512-yodFGwcyt59XRh7w5W3jPcIQb3Bwi21suEfT7MAWnBX3iCdklJpgDgvGT9o04UonglZN5SNMfJFkHIR/jO8GHw=="
},
+ "sort-asc": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/sort-asc/-/sort-asc-0.2.0.tgz",
+ "integrity": "sha512-umMGhjPeHAI6YjABoSTrFp2zaBtXBej1a0yKkuMUyjjqu6FJsTF+JYwCswWDg+zJfk/5npWUUbd33HH/WLzpaA=="
+ },
+ "sort-desc": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/sort-desc/-/sort-desc-0.2.0.tgz",
+ "integrity": "sha512-NqZqyvL4VPW+RAxxXnB8gvE1kyikh8+pR+T+CXLksVRN9eiQqkQlPwqWYU0mF9Jm7UnctShlxLyAt1CaBOTL1w=="
+ },
+ "sort-object": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/sort-object/-/sort-object-3.0.3.tgz",
+ "integrity": "sha512-nK7WOY8jik6zaG9CRwZTaD5O7ETWDLZYMM12pqY8htll+7dYeqGfEUPcUBHOpSJg2vJOrvFIY2Dl5cX2ih1hAQ==",
+ "requires": {
+ "bytewise": "^1.1.0",
+ "get-value": "^2.0.2",
+ "is-extendable": "^0.1.1",
+ "sort-asc": "^0.2.0",
+ "sort-desc": "^0.2.0",
+ "union-value": "^1.0.1"
+ }
+ },
"source-list-map": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/source-list-map/-/source-list-map-2.0.1.tgz",
@@ -10537,6 +11245,33 @@
"integrity": "sha512-J+FWzZoynJEXGphVIS+XEh3kFSjZX/1i9gFBaWQcB+/tmpe2qUsSBABpcxqxnAxFdiUFEgAX1bjYGQvIZmoz9Q==",
"dev": true
},
+ "split-string": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/split-string/-/split-string-3.1.0.tgz",
+ "integrity": "sha512-NzNVhJDYpwceVVii8/Hu6DKfD2G+NrQHlS/V/qgv763EYudVwEcMQNxd2lh+0VrUByXN/oJkl5grOhYWvQUYiw==",
+ "requires": {
+ "extend-shallow": "^3.0.0"
+ },
+ "dependencies": {
+ "extend-shallow": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-3.0.2.tgz",
+ "integrity": "sha512-BwY5b5Ql4+qZoefgMj2NUmx+tehVTH/Kf4k1ZEtOHNFcm2wSxMRo992l6X3TIgni2eZVTZ85xMOjF31fwZAj6Q==",
+ "requires": {
+ "assign-symbols": "^1.0.0",
+ "is-extendable": "^1.0.1"
+ }
+ },
+ "is-extendable": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-1.0.1.tgz",
+ "integrity": "sha512-arnXMxT1hhoKo9k1LZdmlNyJdDDfy2v0fXjFlmok4+i8ul/6WlbVge9bhM74OpNPQPMGUToDtz+KXa1PneJxOA==",
+ "requires": {
+ "is-plain-object": "^2.0.4"
+ }
+ }
+ }
+ },
"ssri": {
"version": "8.0.1",
"resolved": "https://registry.npmjs.org/ssri/-/ssri-8.0.1.tgz",
@@ -11022,6 +11757,19 @@
"integrity": "sha512-6OSu9PTIzmn9TCDiovULTnET6BgXtDYL4Gg4szY+cGsc3JP1dQL8qvE8kShTRx1NIw4Q9IBHlwODjkjWEtMUyA==",
"dev": true
},
+ "typewise": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/typewise/-/typewise-1.0.3.tgz",
+ "integrity": "sha512-aXofE06xGhaQSPzt8hlTY+/YWQhm9P0jYUp1f2XtmW/3Bk0qzXcyFWAtPoo2uTGQj1ZwbDuSyuxicq+aDo8lCQ==",
+ "requires": {
+ "typewise-core": "^1.2.0"
+ }
+ },
+ "typewise-core": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/typewise-core/-/typewise-core-1.2.0.tgz",
+ "integrity": "sha512-2SCC/WLzj2SbUwzFOzqMCkz5amXLlxtJqDKTICqg30x+2DZxcfZN2MvQZmGfXWKNWaKK9pBPsvkcwv8bF/gxKg=="
+ },
"unbox-primitive": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz",
@@ -11039,6 +11787,17 @@
"resolved": "https://registry.npmjs.org/underscore/-/underscore-1.12.1.tgz",
"integrity": "sha512-hEQt0+ZLDVUMhebKxL4x1BTtDY7bavVofhZ9KZ4aI26X9SRaE+Y3m83XUL1UP2jn8ynjndwCCpEHdUG+9pP1Tw=="
},
+ "union-value": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz",
+ "integrity": "sha512-tJfXmxMeWYnczCVs7XAEvIV7ieppALdyepWMkHkwciRpZraG/xwT+s2JN8+pr1+8jCRf80FFzvr+MpQeeoF4Xg==",
+ "requires": {
+ "arr-union": "^3.1.0",
+ "get-value": "^2.0.6",
+ "is-extendable": "^0.1.1",
+ "set-value": "^2.0.1"
+ }
+ },
"uniq": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/uniq/-/uniq-1.0.1.tgz",
diff --git a/packages/javascript/jupyterlab-plotly/package.json b/packages/javascript/jupyterlab-plotly/package.json
index e564735be5d..e12b3b4653e 100644
--- a/packages/javascript/jupyterlab-plotly/package.json
+++ b/packages/javascript/jupyterlab-plotly/package.json
@@ -1,6 +1,6 @@
{
"name": "jupyterlab-plotly",
- "version": "5.23.0",
+ "version": "5.24.0",
"description": "The plotly Jupyter extension",
"author": "The plotly.py team",
"license": "MIT",
@@ -65,7 +65,7 @@
"@lumino/messaging": "^1.2.3",
"@lumino/widgets": "^1.8.1",
"lodash": "^4.17.4",
- "plotly.js": "^2.34.0"
+ "plotly.js": "^2.35.0"
},
"jupyterlab": {
"extension": "lib/jupyterlab-plugin",
diff --git a/packages/python/plotly/_plotly_utils/basevalidators.py b/packages/python/plotly/_plotly_utils/basevalidators.py
index e0ce3e4f2de..21731afad43 100644
--- a/packages/python/plotly/_plotly_utils/basevalidators.py
+++ b/packages/python/plotly/_plotly_utils/basevalidators.py
@@ -950,7 +950,8 @@ def validate_coerce(self, v):
invalid_els = [
e
for e in v
- if not (self.min_val <= e <= self.max_val) and e not in self.extras
+ if not (isinstance(e, int) and self.min_val <= e <= self.max_val)
+ and e not in self.extras
]
if invalid_els:
diff --git a/packages/python/plotly/_plotly_utils/tests/validators/test_integer_validator.py b/packages/python/plotly/_plotly_utils/tests/validators/test_integer_validator.py
index 8b7cb1dbf48..9a01fde7e41 100644
--- a/packages/python/plotly/_plotly_utils/tests/validators/test_integer_validator.py
+++ b/packages/python/plotly/_plotly_utils/tests/validators/test_integer_validator.py
@@ -33,6 +33,18 @@ def validator_aok(request):
return IntegerValidator("prop", "parent", min=-2, max=10, array_ok=True)
+@pytest.fixture
+def validator_extras():
+ return IntegerValidator("prop", "parent", min=-2, max=10, extras=["normal", "bold"])
+
+
+@pytest.fixture
+def validator_extras_aok():
+ return IntegerValidator(
+ "prop", "parent", min=-2, max=10, array_ok=True, extras=["normal", "bold"]
+ )
+
+
# ### Acceptance ###
@pytest.mark.parametrize("val", [1, -19, 0, -1234])
def test_acceptance(val, validator):
@@ -57,6 +69,27 @@ def test_acceptance_min_max(val, validator_min_max):
assert validator_min_max.validate_coerce(val) == approx(val)
+# With extras
+@pytest.mark.parametrize("val", ["normal", "bold", 10, -2])
+def test_acceptance_extras(val, validator_extras):
+ assert validator_extras.validate_coerce(val) == val
+
+
+# Test extras for array_ok
+@pytest.mark.parametrize("val", [[10, "normal", "bold"], ["normal"], [10, -2], [5]])
+def test_acceptance_extras_array(val, validator_extras_aok):
+ assert validator_extras_aok.validate_coerce(val) == val
+
+
+# Test rejection by extras
+@pytest.mark.parametrize("val", ["invalid value", "different invalid value", -3, 11])
+def test_rejection_extras(val, validator_extras):
+ with pytest.raises(ValueError) as validation_failure:
+ validator_extras.validate_coerce(val)
+
+ assert "Invalid value" in str(validation_failure.value)
+
+
@pytest.mark.parametrize(
"val", [-1.01, -10, 2.1, 3, np.iinfo(int).max, np.iinfo(int).min]
)
diff --git a/packages/python/plotly/codegen/resources/plot-schema.json b/packages/python/plotly/codegen/resources/plot-schema.json
index 01a86088c8d..289445a355f 100644
--- a/packages/python/plotly/codegen/resources/plot-schema.json
+++ b/packages/python/plotly/codegen/resources/plot-schema.json
@@ -136,7 +136,7 @@
]
},
"doubleClickDelay": {
- "description": "Sets the delay for registering a double-click in ms. This is the time interval (in ms) between first mousedown and 2nd mouseup to constitute a double-click. This setting propagates to all on-subplot double clicks (except for geo and mapbox) and on-legend double clicks.",
+ "description": "Sets the delay for registering a double-click in ms. This is the time interval (in ms) between first mousedown and 2nd mouseup to constitute a double-click. This setting propagates to all on-subplot double clicks (except for geo, mapbox and map) and on-legend double clicks.",
"dflt": 300,
"min": 0,
"valType": "number"
@@ -295,8 +295,8 @@
"valType": "boolean"
},
"scrollZoom": {
- "description": "Determines whether mouse wheel or two-finger scroll zooms is enable. Turned on by default for gl3d, geo and mapbox subplots (as these subplot types do not have zoombox via pan), but turned off by default for cartesian subplots. Set `scrollZoom` to *false* to disable scrolling for all subplots.",
- "dflt": "gl3d+geo+mapbox",
+ "description": "Determines whether mouse wheel or two-finger scroll zooms is enable. Turned on by default for gl3d, geo, mapbox and map subplots (as these subplot types do not have zoombox via pan), but turned off by default for cartesian subplots. Set `scrollZoom` to *false* to disable scrolling for all subplots.",
+ "dflt": "gl3d+geo+map",
"extras": [
true,
false
@@ -305,7 +305,8 @@
"cartesian",
"gl3d",
"geo",
- "mapbox"
+ "mapbox",
+ "map"
],
"valType": "flaglist"
},
@@ -3871,6 +3872,405 @@
]
}
},
+ "map": {
+ "_arrayAttrRegexps": [
+ {}
+ ],
+ "_isSubplotObj": true,
+ "bearing": {
+ "description": "Sets the bearing angle of the map in degrees counter-clockwise from North (map.bearing).",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "number"
+ },
+ "bounds": {
+ "east": {
+ "description": "Sets the maximum longitude of the map (in degrees East) if `west`, `south` and `north` are declared.",
+ "editType": "plot",
+ "valType": "number"
+ },
+ "editType": "plot",
+ "north": {
+ "description": "Sets the maximum latitude of the map (in degrees North) if `east`, `west` and `south` are declared.",
+ "editType": "plot",
+ "valType": "number"
+ },
+ "role": "object",
+ "south": {
+ "description": "Sets the minimum latitude of the map (in degrees North) if `east`, `west` and `north` are declared.",
+ "editType": "plot",
+ "valType": "number"
+ },
+ "west": {
+ "description": "Sets the minimum longitude of the map (in degrees East) if `east`, `south` and `north` are declared.",
+ "editType": "plot",
+ "valType": "number"
+ }
+ },
+ "center": {
+ "editType": "plot",
+ "lat": {
+ "description": "Sets the latitude of the center of the map (in degrees North).",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "number"
+ },
+ "lon": {
+ "description": "Sets the longitude of the center of the map (in degrees East).",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "number"
+ },
+ "role": "object"
+ },
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this map subplot .",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "integer"
+ },
+ "editType": "plot",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this map subplot .",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "integer"
+ },
+ "x": {
+ "description": "Sets the horizontal domain of this map subplot (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "plot",
+ "items": [
+ {
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "y": {
+ "description": "Sets the vertical domain of this map subplot (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "plot",
+ "items": [
+ {
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ }
+ },
+ "editType": "plot",
+ "layers": {
+ "items": {
+ "layer": {
+ "below": {
+ "description": "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.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "circle": {
+ "editType": "plot",
+ "radius": {
+ "description": "Sets the circle radius (map.layer.paint.circle-radius). Has an effect only when `type` is set to *circle*.",
+ "dflt": 15,
+ "editType": "plot",
+ "valType": "number"
+ },
+ "role": "object"
+ },
+ "color": {
+ "description": "Sets the primary layer color. If `type` is *circle*, color corresponds to the circle color (map.layer.paint.circle-color) If `type` is *line*, color corresponds to the line color (map.layer.paint.line-color) If `type` is *fill*, color corresponds to the fill color (map.layer.paint.fill-color) If `type` is *symbol*, color corresponds to the icon color (map.layer.paint.icon-color)",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "coordinates": {
+ "description": "Sets the coordinates array contains [longitude, latitude] pairs for the image corners listed in clockwise order: top left, top right, bottom right, bottom left. Only has an effect for *image* `sourcetype`.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "editType": "plot",
+ "fill": {
+ "editType": "plot",
+ "outlinecolor": {
+ "description": "Sets the fill outline color (map.layer.paint.fill-outline-color). Has an effect only when `type` is set to *fill*.",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "role": "object"
+ },
+ "line": {
+ "dash": {
+ "description": "Sets the length of dashes and gaps (map.layer.paint.line-dasharray). Has an effect only when `type` is set to *line*.",
+ "editType": "plot",
+ "valType": "data_array"
+ },
+ "dashsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `dash`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "plot",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (map.layer.paint.line-width). Has an effect only when `type` is set to *line*.",
+ "dflt": 2,
+ "editType": "plot",
+ "valType": "number"
+ }
+ },
+ "maxzoom": {
+ "description": "Sets the maximum zoom level (map.layer.maxzoom). At zoom levels equal to or greater than the maxzoom, the layer will be hidden.",
+ "dflt": 24,
+ "editType": "plot",
+ "max": 24,
+ "min": 0,
+ "valType": "number"
+ },
+ "minzoom": {
+ "description": "Sets the minimum zoom level (map.layer.minzoom). At zoom levels less than the minzoom, the layer will be hidden.",
+ "dflt": 0,
+ "editType": "plot",
+ "max": 24,
+ "min": 0,
+ "valType": "number"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the layer. If `type` is *circle*, opacity corresponds to the circle opacity (map.layer.paint.circle-opacity) If `type` is *line*, opacity corresponds to the line opacity (map.layer.paint.line-opacity) If `type` is *fill*, opacity corresponds to the fill opacity (map.layer.paint.fill-opacity) If `type` is *symbol*, opacity corresponds to the icon/text opacity (map.layer.paint.text-opacity)",
+ "dflt": 1,
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "source": {
+ "description": "Sets the source data for this layer (map.layer.source). When `sourcetype` is set to *geojson*, `source` can be a URL to a GeoJSON or a GeoJSON object. When `sourcetype` is set to *vector* or *raster*, `source` can be a URL or an array of tile URLs. When `sourcetype` is set to *image*, `source` can be a URL to an image.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "sourceattribution": {
+ "description": "Sets the attribution for this source.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "sourcelayer": {
+ "description": "Specifies the layer to use from a vector tile source (map.layer.source-layer). Required for *vector* source type that supports multiple layers.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "sourcetype": {
+ "description": "Sets the source type for this layer, that is the type of the layer data.",
+ "dflt": "geojson",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "geojson",
+ "vector",
+ "raster",
+ "image"
+ ]
+ },
+ "symbol": {
+ "editType": "plot",
+ "icon": {
+ "description": "Sets the symbol icon image (map.layer.layout.icon-image). Full list: https://www.map.com/maki-icons/",
+ "dflt": "marker",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "iconsize": {
+ "description": "Sets the symbol icon size (map.layer.layout.icon-size). Has an effect only when `type` is set to *symbol*.",
+ "dflt": 10,
+ "editType": "plot",
+ "valType": "number"
+ },
+ "placement": {
+ "description": "Sets the symbol and/or text placement (map.layer.layout.symbol-placement). If `placement` is *point*, the label is placed where the geometry is located If `placement` is *line*, the label is placed along the line of the geometry If `placement` is *line-center*, the label is placed on the center of the geometry",
+ "dflt": "point",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "point",
+ "line",
+ "line-center"
+ ]
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the symbol text (map.layer.layout.text-field).",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "textfont": {
+ "color": {
+ "editType": "plot",
+ "valType": "color"
+ },
+ "description": "Sets the icon text font (color=map.layer.paint.text-color, size=map.layer.layout.text-size). Has an effect only when `type` is set to *symbol*.",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "dflt": "Open Sans Regular, Arial Unicode MS Regular",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "role": "object",
+ "size": {
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "textposition": {
+ "arrayOk": false,
+ "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
+ "dflt": "middle center",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle left",
+ "middle center",
+ "middle right",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ]
+ }
+ },
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "type": {
+ "description": "Sets the layer type, that is the how the layer data set in `source` will be rendered With `sourcetype` set to *geojson*, the following values are allowed: *circle*, *line*, *fill* and *symbol*. but note that *line* and *fill* are not compatible with Point GeoJSON geometries. With `sourcetype` set to *vector*, the following values are allowed: *circle*, *line*, *fill* and *symbol*. With `sourcetype` set to *raster* or `*image*`, only the *raster* value is allowed.",
+ "dflt": "circle",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "circle",
+ "line",
+ "fill",
+ "symbol",
+ "raster"
+ ]
+ },
+ "visible": {
+ "description": "Determines whether this layer is displayed",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ }
+ }
+ },
+ "role": "object"
+ },
+ "pitch": {
+ "description": "Sets the pitch angle of the map (in degrees, where *0* means perpendicular to the surface of the map) (map.pitch).",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "number"
+ },
+ "role": "object",
+ "style": {
+ "description": "Defines the map layers that are rendered by default below the trace layers defined in `data`, which are themselves by default rendered below the layers defined in `layout.map.layers`. These layers can be defined either explicitly as a Map Style object which can contain multiple layer definitions that load data from any public or private Tile Map Service (TMS or XYZ) or Web Map Service (WMS) or implicitly by using one of the built-in style objects which use WMSes or by using a custom style URL Map Style objects are of the form described in the MapLibre GL JS documentation available at https://maplibre.org/maplibre-style-spec/ The built-in plotly.js styles objects are: basic, carto-darkmatter, carto-darkmatter-nolabels, carto-positron, carto-positron-nolabels, carto-voyager, carto-voyager-nolabels, dark, light, open-street-map, outdoors, satellite, satellite-streets, streets, white-bg.",
+ "dflt": "basic",
+ "editType": "plot",
+ "valType": "any",
+ "values": [
+ "basic",
+ "carto-darkmatter",
+ "carto-darkmatter-nolabels",
+ "carto-positron",
+ "carto-positron-nolabels",
+ "carto-voyager",
+ "carto-voyager-nolabels",
+ "dark",
+ "light",
+ "open-street-map",
+ "outdoors",
+ "satellite",
+ "satellite-streets",
+ "streets",
+ "white-bg"
+ ]
+ },
+ "uirevision": {
+ "description": "Controls persistence of user-driven changes in the view: `center`, `zoom`, `bearing`, `pitch`. Defaults to `layout.uirevision`.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "zoom": {
+ "description": "Sets the zoom level of the map (map.zoom).",
+ "dflt": 1,
+ "editType": "plot",
+ "valType": "number"
+ }
+ },
"mapbox": {
"_arrayAttrRegexps": [
{}
@@ -4387,7 +4787,7 @@
},
"remove": {
"arrayOk": true,
- "description": "Determines which predefined modebar buttons to remove. Similar to `config.modeBarButtonsToRemove` option. This may include *autoScale2d*, *autoscale*, *editInChartStudio*, *editinchartstudio*, *hoverCompareCartesian*, *hovercompare*, *lasso*, *lasso2d*, *orbitRotation*, *orbitrotation*, *pan*, *pan2d*, *pan3d*, *reset*, *resetCameraDefault3d*, *resetCameraLastSave3d*, *resetGeo*, *resetSankeyGroup*, *resetScale2d*, *resetViewMapbox*, *resetViews*, *resetcameradefault*, *resetcameralastsave*, *resetsankeygroup*, *resetscale*, *resetview*, *resetviews*, *select*, *select2d*, *sendDataToCloud*, *senddatatocloud*, *tableRotation*, *tablerotation*, *toImage*, *toggleHover*, *toggleSpikelines*, *togglehover*, *togglespikelines*, *toimage*, *zoom*, *zoom2d*, *zoom3d*, *zoomIn2d*, *zoomInGeo*, *zoomInMapbox*, *zoomOut2d*, *zoomOutGeo*, *zoomOutMapbox*, *zoomin*, *zoomout*.",
+ "description": "Determines which predefined modebar buttons to remove. Similar to `config.modeBarButtonsToRemove` option. This may include *autoScale2d*, *autoscale*, *editInChartStudio*, *editinchartstudio*, *hoverCompareCartesian*, *hovercompare*, *lasso*, *lasso2d*, *orbitRotation*, *orbitrotation*, *pan*, *pan2d*, *pan3d*, *reset*, *resetCameraDefault3d*, *resetCameraLastSave3d*, *resetGeo*, *resetSankeyGroup*, *resetScale2d*, *resetViewMap*, *resetViewMapbox*, *resetViews*, *resetcameradefault*, *resetcameralastsave*, *resetsankeygroup*, *resetscale*, *resetview*, *resetviews*, *select*, *select2d*, *sendDataToCloud*, *senddatatocloud*, *tableRotation*, *tablerotation*, *toImage*, *toggleHover*, *toggleSpikelines*, *togglehover*, *togglespikelines*, *toimage*, *zoom*, *zoom2d*, *zoom3d*, *zoomIn2d*, *zoomInGeo*, *zoomInMap*, *zoomInMapbox*, *zoomOut2d*, *zoomOutGeo*, *zoomOutMap*, *zoomOutMapbox*, *zoomin*, *zoomout*.",
"dflt": "",
"editType": "modebar",
"valType": "string"
@@ -26684,7 +27084,7 @@
},
"type": "choropleth"
},
- "choroplethmapbox": {
+ "choroplethmap": {
"animatable": false,
"attributes": {
"autocolorscale": {
@@ -26695,7 +27095,7 @@
"valType": "boolean"
},
"below": {
- "description": "Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer.",
+ "description": "Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmap traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer.",
"editType": "plot",
"valType": "string"
},
@@ -27958,8 +28358,8 @@
}
},
"subplot": {
- "description": "Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.",
- "dflt": "mapbox",
+ "description": "Sets a reference between this trace's data coordinates and a map subplot. If *map* (the default value), the data refer to `layout.map`. If *map2*, the data refer to `layout.map2`, and so on.",
+ "dflt": "map",
"editType": "calc",
"valType": "subplotid"
},
@@ -27985,7 +28385,7 @@
},
"role": "object"
},
- "type": "choroplethmapbox",
+ "type": "choroplethmap",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -28066,32 +28466,20 @@
}
},
"categories": [
- "mapbox",
+ "map",
"gl",
"noOpacity",
"showLegend"
],
"meta": {
"description": "GeoJSON features to be filled are set in `geojson` The data that describes the choropleth value-to-color mapping is set in `locations` and `z`.",
- "hr_name": "choropleth_mapbox"
+ "hr_name": "choropleth_map"
},
- "type": "choroplethmapbox"
+ "type": "choroplethmap"
},
- "cone": {
+ "choroplethmapbox": {
"animatable": false,
"attributes": {
- "anchor": {
- "description": "Sets the cones' anchor with respect to their x/y/z positions. Note that *cm* denote the cone's center of mass which corresponds to 1/4 from the tail to tip.",
- "dflt": "cm",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "tip",
- "tail",
- "cm",
- "center"
- ]
- },
"autocolorscale": {
"description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
"dflt": true,
@@ -28099,37 +28487,10 @@
"impliedEdits": {},
"valType": "boolean"
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
+ "below": {
+ "description": "Determines if the choropleth polygons will be inserted before the layer with the specified ID. By default, choroplethmapbox traces are placed above the water layers. If set to '', the layer will be inserted above every existing layer.",
+ "editType": "plot",
+ "valType": "string"
},
"coloraxis": {
"description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
@@ -28851,7 +29212,7 @@
}
},
"colorscale": {
- "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
"dflt": null,
"editType": "calc",
"impliedEdits": {
@@ -28869,10 +29230,21 @@
"editType": "none",
"valType": "string"
},
+ "featureidkey": {
+ "description": "Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Support nested property, for example *properties.name*.",
+ "dflt": "id",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "geojson": {
+ "description": "Sets the GeoJSON data associated with this trace. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*.",
+ "editType": "calc",
+ "valType": "any"
+ },
"hoverinfo": {
"arrayOk": true,
"description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "x+y+z+norm+text+name",
+ "dflt": "all",
"editType": "calc",
"extras": [
"all",
@@ -28880,13 +29252,8 @@
"skip"
],
"flags": [
- "x",
- "y",
+ "location",
"z",
- "u",
- "v",
- "w",
- "norm",
"text",
"name"
],
@@ -29098,9 +29465,9 @@
},
"hovertemplate": {
"arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `norm` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `properties` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
"dflt": "",
- "editType": "calc",
+ "editType": "none",
"valType": "string"
},
"hovertemplatesrc": {
@@ -29253,93 +29620,62 @@
"min": 0,
"valType": "number"
},
- "lighting": {
- "ambient": {
- "description": "Ambient light increases overall color visibility but can wash out the image.",
- "dflt": 0.8,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "diffuse": {
- "description": "Represents the extent that incident rays are reflected in a range of angles.",
- "dflt": 0.8,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
+ "locations": {
+ "description": "Sets which features found in *geojson* to plot using their feature `id` field.",
"editType": "calc",
- "facenormalsepsilon": {
- "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 0.000001,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "fresnel": {
- "description": "Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.",
- "dflt": 0.2,
- "editType": "calc",
- "max": 5,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "roughness": {
- "description": "Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.",
- "dflt": 0.5,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "specular": {
- "description": "Represents the level that incident rays are reflected in a single direction, causing shine.",
- "dflt": 0.05,
+ "valType": "data_array"
+ },
+ "locationssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "marker": {
+ "editType": "calc",
+ "line": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
"editType": "calc",
- "max": 2,
- "min": 0,
- "valType": "number"
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "dflt": 1,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
},
- "vertexnormalsepsilon": {
- "description": "Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 1e-12,
- "editType": "calc",
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the opacity of the locations.",
+ "dflt": 1,
+ "editType": "plot",
"max": 1,
"min": 0,
"valType": "number"
- }
- },
- "lightposition": {
- "editType": "calc",
- "role": "object",
- "x": {
- "description": "Numeric vector, representing the X coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number"
},
- "y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number"
+ "opacitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "editType": "none",
+ "valType": "string"
},
- "z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number"
- }
+ "role": "object"
},
"meta": {
"arrayOk": true,
@@ -29357,25 +29693,31 @@
"editType": "style",
"valType": "string"
},
- "opacity": {
- "description": "Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
"reversescale": {
- "description": "Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.",
+ "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
"dflt": false,
"editType": "plot",
"valType": "boolean"
},
- "scene": {
- "description": "Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.",
- "dflt": "scene",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
+ "selected": {
+ "editType": "plot",
+ "marker": {
+ "editType": "plot",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object"
+ },
+ "role": "object"
+ },
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
+ "editType": "calc",
+ "valType": "any"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
@@ -29389,23 +29731,6 @@
"editType": "calc",
"valType": "boolean"
},
- "sizemode": {
- "description": "Determines whether `sizeref` is set as a *scaled* (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as *absolute* value (in the same units as the vector field). To display sizes in actual vector length use *raw*.",
- "dflt": "scaled",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "scaled",
- "absolute",
- "raw"
- ]
- },
- "sizeref": {
- "description": "Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum \"time\" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to *raw*, its default value is *1*. With `sizemode` set to *scaled*, `sizeref` is unitless, its default value is *0.5*. With `sizemode` set to *absolute*, `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
"stream": {
"editType": "calc",
"maxpoints": {
@@ -29425,9 +29750,15 @@
"valType": "string"
}
},
+ "subplot": {
+ "description": "mapbox subplots and traces are deprecated! Please consider switching to `map` subplots and traces. Learn more at: https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.",
+ "dflt": "mapbox",
+ "editType": "calc",
+ "valType": "subplotid"
+ },
"text": {
"arrayOk": true,
- "description": "Sets the text elements associated with the cones. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "description": "Sets the text elements associated with each location.",
"dflt": "",
"editType": "calc",
"valType": "string"
@@ -29437,18 +29768,17 @@
"editType": "none",
"valType": "string"
},
- "type": "cone",
- "u": {
- "description": "Sets the x components of the vector field.",
- "editType": "calc",
- "valType": "data_array"
- },
- "uhoverformat": {
- "description": "Sets the hover text formatting rulefor `u` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
},
+ "type": "choroplethmapbox",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -29459,21 +29789,20 @@
"editType": "none",
"valType": "any"
},
- "usrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `u`.",
- "editType": "none",
- "valType": "string"
- },
- "v": {
- "description": "Sets the y components of the vector field.",
- "editType": "calc",
- "valType": "data_array"
- },
- "vhoverformat": {
- "description": "Sets the hover text formatting rulefor `v` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
+ "unselected": {
+ "editType": "plot",
+ "marker": {
+ "editType": "plot",
+ "opacity": {
+ "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object"
+ },
+ "role": "object"
},
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
@@ -29486,69 +29815,42 @@
"legendonly"
]
},
- "vsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `v`.",
- "editType": "none",
- "valType": "string"
- },
- "w": {
- "description": "Sets the z components of the vector field.",
+ "z": {
+ "description": "Sets the color values.",
"editType": "calc",
"valType": "data_array"
},
- "whoverformat": {
- "description": "Sets the hover text formatting rulefor `w` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "wsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `w`.",
- "editType": "none",
- "valType": "string"
- },
- "x": {
- "description": "Sets the x coordinates of the vector field and of the displayed cones.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "y": {
- "description": "Sets the y coordinates of the vector field and of the displayed cones.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
+ "zauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
+ "zmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "zauto": false
+ },
+ "valType": "number"
},
- "z": {
- "description": "Sets the z coordinates of the vector field and of the displayed cones.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
+ "zmid": {
+ "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
},
- "zhoverformat": {
- "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `zaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
+ "zmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "zauto": false
+ },
+ "valType": "number"
},
"zsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `z`.",
@@ -29557,31 +29859,71 @@
}
},
"categories": [
- "gl3d",
+ "mapbox",
+ "gl",
+ "noOpacity",
"showLegend"
],
"meta": {
- "description": "Use cone traces to visualize vector fields. Specify a vector field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, `w`. The cones are drawn exactly at the positions given by `x`, `y` and `z`."
+ "description": "*choroplethmapbox* trace is deprecated! Please consider switching to the *choroplethmap* trace type and `map` subplots. Learn more at: https://plotly.com/javascript/maplibre-migration/ GeoJSON features to be filled are set in `geojson` The data that describes the choropleth value-to-color mapping is set in `locations` and `z`.",
+ "hr_name": "choropleth_mapbox"
},
- "type": "cone"
+ "type": "choroplethmapbox"
},
- "contour": {
+ "cone": {
"animatable": false,
"attributes": {
+ "anchor": {
+ "description": "Sets the cones' anchor with respect to their x/y/z positions. Note that *cm* denote the cone's center of mass which corresponds to 1/4 from the tail to tip.",
+ "dflt": "cm",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "tip",
+ "tail",
+ "cm",
+ "center"
+ ]
+ },
"autocolorscale": {
"description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": false,
+ "dflt": true,
"editType": "calc",
"impliedEdits": {},
"valType": "boolean"
},
- "autocontour": {
- "description": "Determines whether or not the contour level attributes are picked by an algorithm. If *true*, the number of contour levels can be set in `ncontours`. If *false*, set the contour level attributes in `contours`.",
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here u/v/w norm) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
"dflt": true,
"editType": "calc",
"impliedEdits": {},
"valType": "boolean"
},
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as u/v/w norm. Has no effect when `cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as u/v/w norm and if set, `cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
"coloraxis": {
"description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
"dflt": null,
@@ -30302,7 +30644,7 @@
}
},
"colorscale": {
- "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
"dflt": null,
"editType": "calc",
"impliedEdits": {
@@ -30310,203 +30652,6 @@
},
"valType": "colorscale"
},
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array otherwise it is defaulted to false.",
- "editType": "calc",
- "valType": "boolean"
- },
- "contours": {
- "coloring": {
- "description": "Determines the coloring method showing the contour values. If *fill*, coloring is done evenly between each contour level If *heatmap*, a heatmap gradient coloring is applied between each contour level. If *lines*, coloring is done on the contour lines. If *none*, no coloring is applied on this trace.",
- "dflt": "fill",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fill",
- "heatmap",
- "lines",
- "none"
- ]
- },
- "editType": "calc",
- "end": {
- "description": "Sets the end contour level value. Must be more than `contours.start`",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "^autocontour": false
- },
- "valType": "number"
- },
- "impliedEdits": {
- "autocontour": false,
- "role": "object"
- },
- "labelfont": {
- "color": {
- "editType": "style",
- "valType": "color"
- },
- "description": "Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "labelformat": {
- "description": "Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- },
- "operation": {
- "description": "Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.",
- "dflt": "=",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "=",
- "<",
- ">=",
- ">",
- "<=",
- "[]",
- "()",
- "[)",
- "(]",
- "][",
- ")(",
- "](",
- ")["
- ]
- },
- "role": "object",
- "showlabels": {
- "description": "Determines whether to label the contour lines with their values.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "showlines": {
- "description": "Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to *fill*.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
- },
- "size": {
- "description": "Sets the step between each contour level. Must be positive.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "^autocontour": false
- },
- "min": 0,
- "valType": "number"
- },
- "start": {
- "description": "Sets the starting contour level value. Must be less than `contours.end`",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "^autocontour": false
- },
- "valType": "number"
- },
- "type": {
- "description": "If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.",
- "dflt": "levels",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "levels",
- "constraint"
- ]
- },
- "value": {
- "description": "Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) *value* is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) *value* is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.",
- "dflt": 0,
- "editType": "calc",
- "valType": "any"
- }
- },
"customdata": {
"description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
"editType": "calc",
@@ -30517,34 +30662,11 @@
"editType": "none",
"valType": "string"
},
- "dx": {
- "description": "Sets the x coordinate step. See `x0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "number"
- },
- "dy": {
- "description": "Sets the y coordinate step. See `y0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "number"
- },
- "fillcolor": {
- "description": "Sets the fill color if `contours.type` is *constraint*. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.",
- "editType": "calc",
- "valType": "color"
- },
"hoverinfo": {
"arrayOk": true,
"description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
+ "dflt": "x+y+z+norm+text+name",
+ "editType": "calc",
"extras": [
"all",
"none",
@@ -30554,6 +30676,10 @@
"x",
"y",
"z",
+ "u",
+ "v",
+ "w",
+ "norm",
"text",
"name"
],
@@ -30763,17 +30889,11 @@
},
"role": "object"
},
- "hoverongaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean"
- },
"hovertemplate": {
"arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `norm` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
"dflt": "",
- "editType": "none",
+ "editType": "calc",
"valType": "string"
},
"hovertemplatesrc": {
@@ -30782,9 +30902,11 @@
"valType": "string"
},
"hovertext": {
+ "arrayOk": true,
"description": "Same as `text`.",
+ "dflt": "",
"editType": "calc",
- "valType": "data_array"
+ "valType": "string"
},
"hovertextsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
@@ -30924,43 +31046,94 @@
"min": 0,
"valType": "number"
},
- "line": {
- "color": {
- "description": "Sets the color of the contour level. Has no effect if `contours.coloring` is set to *lines*.",
- "editType": "style+colorbars",
- "valType": "color"
+ "lighting": {
+ "ambient": {
+ "description": "Ambient light increases overall color visibility but can wash out the image.",
+ "dflt": 0.8,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
- "dflt": "solid",
- "editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ]
+ "diffuse": {
+ "description": "Represents the extent that incident rays are reflected in a range of angles.",
+ "dflt": 0.8,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "editType": "calc",
+ "facenormalsepsilon": {
+ "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 0.000001,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "fresnel": {
+ "description": "Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.",
+ "dflt": 0.2,
+ "editType": "calc",
+ "max": 5,
+ "min": 0,
+ "valType": "number"
},
- "editType": "plot",
"role": "object",
- "smoothing": {
- "description": "Sets the amount of smoothing for the contour lines, where *0* corresponds to no smoothing.",
- "dflt": 1,
- "editType": "plot",
- "max": 1.3,
+ "roughness": {
+ "description": "Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.",
+ "dflt": 0.5,
+ "editType": "calc",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "width": {
- "description": "Sets the contour line width in (in px) Defaults to *0.5* when `contours.type` is *levels*. Defaults to *2* when `contour.type` is *constraint*.",
- "editType": "style+colorbars",
+ "specular": {
+ "description": "Represents the level that incident rays are reflected in a single direction, causing shine.",
+ "dflt": 0.05,
+ "editType": "calc",
+ "max": 2,
+ "min": 0,
+ "valType": "number"
+ },
+ "vertexnormalsepsilon": {
+ "description": "Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 1e-12,
+ "editType": "calc",
+ "max": 1,
"min": 0,
"valType": "number"
}
},
+ "lightposition": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
+ "description": "Numeric vector, representing the X coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ },
+ "y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ },
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ }
+ },
"meta": {
"arrayOk": true,
"description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
@@ -30977,30 +31150,29 @@
"editType": "style",
"valType": "string"
},
- "ncontours": {
- "description": "Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.",
- "dflt": 15,
- "editType": "calc",
- "min": 1,
- "valType": "integer"
- },
"opacity": {
- "description": "Sets the opacity of the trace.",
+ "description": "Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.",
"dflt": 1,
- "editType": "style",
+ "editType": "calc",
"max": 1,
"min": 0,
"valType": "number"
},
"reversescale": {
- "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
+ "description": "Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.",
"dflt": false,
"editType": "plot",
"valType": "boolean"
},
+ "scene": {
+ "description": "Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.",
+ "dflt": "scene",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
+ "dflt": false,
"editType": "style",
"valType": "boolean"
},
@@ -31010,6 +31182,23 @@
"editType": "calc",
"valType": "boolean"
},
+ "sizemode": {
+ "description": "Determines whether `sizeref` is set as a *scaled* (i.e unitless) scalar (normalized by the max u/v/w norm in the vector field) or as *absolute* value (in the same units as the vector field). To display sizes in actual vector length use *raw*.",
+ "dflt": "scaled",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "scaled",
+ "absolute",
+ "raw"
+ ]
+ },
+ "sizeref": {
+ "description": "Adjusts the cone size scaling. The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`. This factor (computed internally) corresponds to the minimum \"time\" to travel across two successive x/y/z positions at the average velocity of those two successive positions. All cones in a given trace use the same factor. With `sizemode` set to *raw*, its default value is *1*. With `sizemode` set to *scaled*, `sizeref` is unitless, its default value is *0.5*. With `sizemode` set to *absolute*, `sizeref` has the same units as the u/v/w vector field, its the default value is half the sample's maximum vector norm.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
"stream": {
"editType": "calc",
"maxpoints": {
@@ -31030,138 +31219,54 @@
}
},
"text": {
- "description": "Sets the text elements associated with each z value.",
+ "arrayOk": true,
+ "description": "Sets the text elements associated with the cones. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
"editType": "calc",
- "valType": "data_array"
- },
- "textfont": {
- "color": {
- "dflt": "auto",
- "editType": "style",
- "valType": "color"
- },
- "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. Sets the text font.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "dflt": "auto",
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "valType": "string"
},
"textsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `text`.",
"editType": "none",
"valType": "string"
},
- "texttemplate": {
- "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.",
+ "type": "cone",
+ "u": {
+ "description": "Sets the x components of the vector field.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "uhoverformat": {
+ "description": "Sets the hover text formatting rulefor `u` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
"dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string"
},
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
},
- "transpose": {
- "description": "Transposes the z data.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "type": "contour",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
+ "usrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `u`.",
+ "editType": "none",
"valType": "string"
},
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "v": {
+ "description": "Sets the y components of the vector field.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "vhoverformat": {
+ "description": "Sets the hover text formatting rulefor `v` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
+ "dflt": "",
"editType": "none",
- "valType": "any"
+ "valType": "string"
},
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
@@ -31174,52 +31279,31 @@
"legendonly"
]
},
- "x": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "xtype": "array"
- },
+ "vsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `v`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "w": {
+ "description": "Sets the z components of the vector field.",
+ "editType": "calc",
"valType": "data_array"
},
- "x0": {
- "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "any"
+ "whoverformat": {
+ "description": "Sets the hover text formatting rulefor `w` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
},
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
+ "wsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `w`.",
+ "editType": "none",
+ "valType": "string"
},
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
+ "x": {
+ "description": "Sets the x coordinates of the vector field and of the displayed cones.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
},
"xhoverformat": {
"description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
@@ -31227,192 +31311,38 @@
"editType": "none",
"valType": "string"
},
- "xperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "any"
- },
- "xperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "xperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
- "dflt": "middle",
- "editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
"xsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `x`.",
"editType": "none",
"valType": "string"
},
- "xtype": {
- "description": "If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "array",
- "scaled"
- ]
- },
"y": {
- "description": "Sets the y coordinates.",
+ "description": "Sets the y coordinates of the vector field and of the displayed cones.",
"editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "ytype": "array"
- },
"valType": "data_array"
},
- "y0": {
- "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "any"
- },
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "ycalendar": {
- "description": "Sets the calendar system to use with `y` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
"yhoverformat": {
"description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
"dflt": "",
"editType": "none",
"valType": "string"
},
- "yperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "any"
- },
- "yperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "yperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
- "dflt": "middle",
- "editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
"ysrc": {
"description": "Sets the source reference on Chart Studio Cloud for `y`.",
"editType": "none",
"valType": "string"
},
- "ytype": {
- "description": "If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "array",
- "scaled"
- ]
- },
"z": {
- "description": "Sets the z data.",
- "editType": "calc",
+ "description": "Sets the z coordinates of the vector field and of the displayed cones.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array"
},
- "zauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
"zhoverformat": {
- "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
+ "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `zaxis.hoverformat`.",
"dflt": "",
"editType": "none",
"valType": "string"
},
- "zmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "zauto": false
- },
- "valType": "number"
- },
- "zmid": {
- "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "zmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "zauto": false
- },
- "valType": "number"
- },
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
- },
"zsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `z`.",
"editType": "none",
@@ -31420,51 +31350,17 @@
}
},
"categories": [
- "cartesian",
- "svg",
- "2dMap",
- "contour",
+ "gl3d",
"showLegend"
],
"meta": {
- "description": "The data from which contour lines are computed is set in `z`. Data in `z` must be a {2D array} of numbers. Say that `z` has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in `y` or auto-generated) and the M columns correspond to M x coordinates (set in `x` or auto-generated). By setting `transpose` to *true*, the above behavior is flipped."
+ "description": "Use cone traces to visualize vector fields. Specify a vector field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, `w`. The cones are drawn exactly at the positions given by `x`, `y` and `z`."
},
- "type": "contour"
+ "type": "cone"
},
- "contourcarpet": {
+ "contour": {
"animatable": false,
"attributes": {
- "a": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "xtype": "array"
- },
- "valType": "data_array"
- },
- "a0": {
- "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "any"
- },
- "asrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `a`.",
- "editType": "none",
- "valType": "string"
- },
- "atype": {
- "description": "If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "array",
- "scaled"
- ]
- },
"autocolorscale": {
"description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
"dflt": false,
@@ -31479,42 +31375,6 @@
"impliedEdits": {},
"valType": "boolean"
},
- "b": {
- "description": "Sets the y coordinates.",
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "ytype": "array"
- },
- "valType": "data_array"
- },
- "b0": {
- "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "any"
- },
- "bsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `b`.",
- "editType": "none",
- "valType": "string"
- },
- "btype": {
- "description": "If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "array",
- "scaled"
- ]
- },
- "carpet": {
- "description": "The `carpet` of the carpet axes on which this contour trace lies",
- "editType": "calc",
- "valType": "string"
- },
"coloraxis": {
"description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
"dflt": null,
@@ -32243,14 +32103,20 @@
},
"valType": "colorscale"
},
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array otherwise it is defaulted to false.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
"contours": {
"coloring": {
- "description": "Determines the coloring method showing the contour values. If *fill*, coloring is done evenly between each contour level If *lines*, coloring is done on the contour lines. If *none*, no coloring is applied on this trace.",
+ "description": "Determines the coloring method showing the contour values. If *fill*, coloring is done evenly between each contour level If *heatmap*, a heatmap gradient coloring is applied between each contour level. If *lines*, coloring is done on the contour lines. If *none*, no coloring is applied on this trace.",
"dflt": "fill",
"editType": "calc",
"valType": "enumerated",
"values": [
"fill",
+ "heatmap",
"lines",
"none"
]
@@ -32444,7 +32310,7 @@
"editType": "none",
"valType": "string"
},
- "da": {
+ "dx": {
"description": "Sets the x coordinate step. See `x0` for more info.",
"dflt": 1,
"editType": "calc",
@@ -32453,7 +32319,7 @@
},
"valType": "number"
},
- "db": {
+ "dy": {
"description": "Sets the y coordinate step. See `y0` for more info.",
"dflt": 1,
"editType": "calc",
@@ -32467,6 +32333,247 @@
"editType": "calc",
"valType": "color"
},
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "hoverongaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
"hovertext": {
"description": "Same as `text`.",
"editType": "calc",
@@ -32720,18 +32827,125 @@
"editType": "calc",
"valType": "data_array"
},
+ "textfont": {
+ "color": {
+ "dflt": "auto",
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. Sets the text font.",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "size": {
+ "dflt": "auto",
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
"textsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `text`.",
"editType": "none",
"valType": "string"
},
+ "texttemplate": {
+ "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
"transpose": {
"description": "Transposes the z data.",
"dflt": false,
"editType": "calc",
"valType": "boolean"
},
- "type": "contourcarpet",
+ "type": "contour",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -32753,103 +32967,350 @@
"legendonly"
]
},
+ "x": {
+ "description": "Sets the x coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "xtype": "array"
+ },
+ "valType": "data_array"
+ },
+ "x0": {
+ "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "any"
+ },
"xaxis": {
"description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
"dflt": "x",
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "z": {
- "description": "Sets the z data.",
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
"editType": "calc",
- "valType": "data_array"
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
},
- "zauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
},
- "zmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
+ "xperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
"impliedEdits": {
- "zauto": false
+ "xtype": "scaled"
},
- "valType": "number"
+ "valType": "any"
},
- "zmid": {
- "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
- "dflt": null,
+ "xperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
"editType": "calc",
- "impliedEdits": {},
- "valType": "number"
+ "valType": "any"
},
- "zmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
+ "xperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
+ "dflt": "middle",
+ "editType": "calc",
"impliedEdits": {
- "zauto": false
+ "xtype": "scaled"
},
- "valType": "number"
- },
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
},
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
"editType": "none",
"valType": "string"
- }
- },
- "categories": [
- "cartesian",
- "svg",
- "carpet",
- "contour",
- "symbols",
- "showLegend",
- "hasLines",
- "carpetDependent",
- "noHover",
- "noSortingByValue"
- ],
- "meta": {
- "description": "Plots contours on either the first carpet axis or the carpet axis with a matching `carpet` attribute. Data `z` is interpreted as matching that of the corresponding carpet axis.",
- "hrName": "contour_carpet"
- },
- "type": "contourcarpet"
- },
- "densitymapbox": {
- "animatable": false,
- "attributes": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
},
- "below": {
- "description": "Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer.",
- "editType": "plot",
- "valType": "string"
+ "xtype": {
+ "description": "If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).",
+ "editType": "calc+clearAxisTypes",
+ "valType": "enumerated",
+ "values": [
+ "array",
+ "scaled"
+ ]
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
+ "y": {
+ "description": "Sets the y coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "ytype": "array"
+ },
+ "valType": "data_array"
+ },
+ "y0": {
+ "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "any"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "yperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "any"
+ },
+ "yperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "yperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
+ "dflt": "middle",
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
+ },
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ytype": {
+ "description": "If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)",
+ "editType": "calc+clearAxisTypes",
+ "valType": "enumerated",
+ "values": [
+ "array",
+ "scaled"
+ ]
+ },
+ "z": {
+ "description": "Sets the z data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "zauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "zmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "zauto": false
+ },
+ "valType": "number"
+ },
+ "zmid": {
+ "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "zmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "zauto": false
+ },
+ "valType": "number"
+ },
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ },
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "categories": [
+ "cartesian",
+ "svg",
+ "2dMap",
+ "contour",
+ "showLegend"
+ ],
+ "meta": {
+ "description": "The data from which contour lines are computed is set in `z`. Data in `z` must be a {2D array} of numbers. Say that `z` has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in `y` or auto-generated) and the M columns correspond to M x coordinates (set in `x` or auto-generated). By setting `transpose` to *true*, the above behavior is flipped."
+ },
+ "type": "contour"
+ },
+ "contourcarpet": {
+ "animatable": false,
+ "attributes": {
+ "a": {
+ "description": "Sets the x coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "xtype": "array"
+ },
+ "valType": "data_array"
+ },
+ "a0": {
+ "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "any"
+ },
+ "asrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `a`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "atype": {
+ "description": "If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).",
+ "editType": "calc+clearAxisTypes",
+ "valType": "enumerated",
+ "values": [
+ "array",
+ "scaled"
+ ]
+ },
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": false,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "autocontour": {
+ "description": "Determines whether or not the contour level attributes are picked by an algorithm. If *true*, the number of contour levels can be set in `ncontours`. If *false*, set the contour level attributes in `contours`.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "b": {
+ "description": "Sets the y coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "ytype": "array"
+ },
+ "valType": "data_array"
+ },
+ "b0": {
+ "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "any"
+ },
+ "bsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `b`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "btype": {
+ "description": "If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)",
+ "editType": "calc+clearAxisTypes",
+ "valType": "enumerated",
+ "values": [
+ "array",
+ "scaled"
+ ]
+ },
+ "carpet": {
+ "description": "The `carpet` of the carpet axes on which this contour trace lies",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid"
@@ -33575,112 +34036,50 @@
},
"valType": "colorscale"
},
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "lon",
- "lat",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
+ "contours": {
+ "coloring": {
+ "description": "Determines the coloring method showing the contour values. If *fill*, coloring is done evenly between each contour level If *lines*, coloring is done on the contour lines. If *none*, no coloring is applied on this trace.",
+ "dflt": "fill",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "left",
- "right",
- "auto"
+ "fill",
+ "lines",
+ "none"
]
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
+ "editType": "calc",
+ "end": {
+ "description": "Sets the end contour level value. Must be more than `contours.start`",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "^autocontour": false
+ },
+ "valType": "number"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "impliedEdits": {
+ "autocontour": false,
+ "role": "object"
},
- "editType": "none",
- "font": {
+ "labelfont": {
"color": {
- "arrayOk": true,
- "editType": "none",
+ "editType": "style",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
+ "description": "Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.",
+ "editType": "plot",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
"lineposition": {
- "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "none",
+ "editType": "plot",
"extras": [
"none"
],
@@ -33691,56 +34090,32 @@
],
"valType": "flaglist"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
- "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
+ "editType": "plot",
"valType": "string"
},
"size": {
- "arrayOk": true,
- "editType": "none",
+ "editType": "plot",
"min": 1,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"style": {
- "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
"textcase": {
- "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -33749,16 +34124,10 @@
"lower"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -33769,16 +34138,10 @@
"unicase"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -33786,46 +34149,121 @@
"max": 1000,
"min": 1,
"valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
}
},
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
+ "labelformat": {
+ "description": "Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
+ "dflt": "",
+ "editType": "plot",
"valType": "string"
},
- "role": "object"
+ "operation": {
+ "description": "Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.",
+ "dflt": "=",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "=",
+ "<",
+ ">=",
+ ">",
+ "<=",
+ "[]",
+ "()",
+ "[)",
+ "(]",
+ "][",
+ ")(",
+ "](",
+ ")["
+ ]
+ },
+ "role": "object",
+ "showlabels": {
+ "description": "Determines whether to label the contour lines with their values.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "showlines": {
+ "description": "Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to *fill*.",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "size": {
+ "description": "Sets the step between each contour level. Must be positive.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "^autocontour": false
+ },
+ "min": 0,
+ "valType": "number"
+ },
+ "start": {
+ "description": "Sets the starting contour level value. Must be less than `contours.end`",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "^autocontour": false
+ },
+ "valType": "number"
+ },
+ "type": {
+ "description": "If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.",
+ "dflt": "levels",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "levels",
+ "constraint"
+ ]
+ },
+ "value": {
+ "description": "Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) *value* is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) *value* is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "any"
+ }
},
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
"editType": "none",
"valType": "string"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "da": {
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "number"
+ },
+ "db": {
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "number"
+ },
+ "fillcolor": {
+ "description": "Sets the fill color if `contours.type` is *constraint*. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.",
+ "editType": "calc",
+ "valType": "color"
},
"hovertext": {
- "arrayOk": true,
- "description": "Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
+ "description": "Same as `text`.",
"editType": "calc",
- "valType": "string"
+ "valType": "data_array"
},
"hovertextsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
@@ -33842,16 +34280,6 @@
"editType": "none",
"valType": "string"
},
- "lat": {
- "description": "Sets the latitude coordinates (in degrees North).",
- "editType": "calc",
- "valType": "data_array"
- },
- "latsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
- "editType": "none",
- "valType": "string"
- },
"legend": {
"description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
"dflt": "legend",
@@ -33975,15 +34403,42 @@
"min": 0,
"valType": "number"
},
- "lon": {
- "description": "Sets the longitude coordinates (in degrees East).",
- "editType": "calc",
- "valType": "data_array"
- },
- "lonsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
- "editType": "none",
- "valType": "string"
+ "line": {
+ "color": {
+ "description": "Sets the color of the contour level. Has no effect if `contours.coloring` is set to *lines*.",
+ "editType": "style+colorbars",
+ "valType": "color"
+ },
+ "dash": {
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
+ "dflt": "solid",
+ "editType": "style",
+ "valType": "string",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ]
+ },
+ "editType": "plot",
+ "role": "object",
+ "smoothing": {
+ "description": "Sets the amount of smoothing for the contour lines, where *0* corresponds to no smoothing.",
+ "dflt": 1,
+ "editType": "plot",
+ "max": 1.3,
+ "min": 0,
+ "valType": "number"
+ },
+ "width": {
+ "description": "Sets the contour line width in (in px) Defaults to *0.5* when `contours.type` is *levels*. Defaults to *2* when `contour.type` is *constraint*.",
+ "editType": "style+colorbars",
+ "min": 0,
+ "valType": "number"
+ }
},
"meta": {
"arrayOk": true,
@@ -34001,6 +34456,13 @@
"editType": "style",
"valType": "string"
},
+ "ncontours": {
+ "description": "Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.",
+ "dflt": 15,
+ "editType": "calc",
+ "min": 1,
+ "valType": "integer"
+ },
"opacity": {
"description": "Sets the opacity of the trace.",
"dflt": 1,
@@ -34009,19 +34471,6 @@
"min": 0,
"valType": "number"
},
- "radius": {
- "arrayOk": true,
- "description": "Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.",
- "dflt": 30,
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "radiussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `radius`.",
- "editType": "none",
- "valType": "string"
- },
"reversescale": {
"description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
"dflt": false,
@@ -34030,7 +34479,7 @@
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
+ "dflt": true,
"editType": "style",
"valType": "boolean"
},
@@ -34059,35 +34508,23 @@
"valType": "string"
}
},
- "subplot": {
- "description": "Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.",
- "dflt": "mapbox",
- "editType": "calc",
- "valType": "subplotid"
- },
"text": {
- "arrayOk": true,
- "description": "Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "dflt": "",
+ "description": "Sets the text elements associated with each z value.",
"editType": "calc",
- "valType": "string"
+ "valType": "data_array"
},
"textsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `text`.",
"editType": "none",
"valType": "string"
},
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
+ "transpose": {
+ "description": "Transposes the z data.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
},
- "type": "densitymapbox",
+ "type": "contourcarpet",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -34109,8 +34546,20 @@
"legendonly"
]
},
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
"z": {
- "description": "Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot",
+ "description": "Sets the z data.",
"editType": "calc",
"valType": "data_array"
},
@@ -34124,7 +34573,7 @@
"zmax": {
"description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
"dflt": null,
- "editType": "calc",
+ "editType": "plot",
"impliedEdits": {
"zauto": false
},
@@ -34140,12 +34589,18 @@
"zmin": {
"description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
"dflt": null,
- "editType": "calc",
+ "editType": "plot",
"impliedEdits": {
"zauto": false
},
"valType": "number"
},
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ },
"zsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `z`.",
"editType": "none",
@@ -34153,548 +34608,350 @@
}
},
"categories": [
- "mapbox",
- "gl",
- "showLegend"
+ "cartesian",
+ "svg",
+ "carpet",
+ "contour",
+ "symbols",
+ "showLegend",
+ "hasLines",
+ "carpetDependent",
+ "noHover",
+ "noSortingByValue"
],
"meta": {
- "description": "Draws a bivariate kernel density estimation with a Gaussian kernel from `lon` and `lat` coordinates and optional `z` values using a colorscale.",
- "hr_name": "density_mapbox"
+ "description": "Plots contours on either the first carpet axis or the carpet axis with a matching `carpet` attribute. Data `z` is interpreted as matching that of the corresponding carpet axis.",
+ "hrName": "contour_carpet"
},
- "type": "densitymapbox"
+ "type": "contourcarpet"
},
- "funnel": {
+ "densitymap": {
"animatable": false,
"attributes": {
- "alignmentgroup": {
- "description": "Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "cliponaxis": {
- "description": "Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.",
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
"dflt": true,
- "editType": "plot",
+ "editType": "calc",
+ "impliedEdits": {},
"valType": "boolean"
},
- "connector": {
+ "below": {
+ "description": "Determines if the densitymap trace will be inserted before the layer with the specified ID. By default, densitymap traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer.",
"editType": "plot",
- "fillcolor": {
- "description": "Sets the fill color.",
- "editType": "style",
- "valType": "color"
- },
- "line": {
- "color": {
- "description": "Sets the line color.",
- "dflt": "#444",
- "editType": "style",
- "valType": "color"
+ "valType": "string"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
+ "valType": "string"
},
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
- "dflt": "solid",
- "editType": "style",
- "valType": "string",
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
+ "valType": "enumerated",
"values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
+ "right",
+ "top",
+ "bottom"
]
- },
- "editType": "style",
- "role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
}
},
- "role": "object",
- "visible": {
- "description": "Determines if connector regions and lines are drawn.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
- }
- },
- "constraintext": {
- "description": "Constrain the size of text inside or outside a bar to be no larger than the bar itself.",
- "dflt": "both",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "inside",
- "outside",
- "both",
- "none"
- ]
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "dx": {
- "description": "Sets the x coordinate step. See `x0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "dy": {
- "description": "Sets the y coordinate step. See `y0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "name",
- "x",
- "y",
- "text",
- "percent initial",
- "percent previous",
- "percent total"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "left",
- "right",
- "auto"
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
]
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
},
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
},
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
},
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
},
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `percentInitial`, `percentPrevious` and `percentTotal`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "insidetextanchor": {
- "description": "Determines if texts are kept at center or start/end points in `textposition` *inside* mode.",
- "dflt": "middle",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "end",
- "middle",
- "start"
- ]
- },
- "insidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "style",
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `text` lying inside the bar.",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
"role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
},
- "size": {
- "arrayOk": true,
- "editType": "calc",
- "min": 1,
- "valType": "number"
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "fraction",
+ "pixels"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "tickfont": {
"color": {
- "editType": "style",
+ "editType": "colorbars",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -34702,7 +34959,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "style",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -34717,18 +34974,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "style",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "style",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -34738,7 +34995,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -34750,7 +35007,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -34764,7 +35021,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -34774,380 +35031,169 @@
"valType": "integer"
}
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
"dflt": "",
- "editType": "style",
+ "editType": "colorbars",
"valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "marker": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "color": {
- "arrayOk": true,
- "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
- "editType": "style",
- "valType": "color"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
"editType": "colorbars",
- "valType": "color"
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
},
- "description": "Deprecated in favor of color bar's `title.font`.",
"editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
"editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "valType": "boolean"
},
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
"editType": "colorbars",
"valType": "string"
},
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
"editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
+ "valType": "string"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
"editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "valType": "string"
}
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
}
},
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
"editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
- },
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "tickfont": {
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
+ },
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
"color": {
"editType": "colorbars",
"valType": "color"
},
- "description": "Sets the color bar's tick label font",
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
"editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
@@ -35231,466 +35277,507 @@
"valType": "integer"
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
+ "right",
+ "top",
+ "bottom"
]
},
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
"editType": "colorbars",
- "min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
- "impliedEdits": {},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ]
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "lon",
+ "lat",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color"
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
"valType": "string"
},
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- ""
- ]
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
"valType": "string"
},
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
"editType": "none",
"valType": "string"
},
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
"editType": "none",
"valType": "string"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
"valType": "number"
},
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
- "valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "left",
- "center",
- "right"
+ "normal",
+ "italic"
]
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
},
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
},
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "top",
- "middle",
- "bottom"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
},
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
"editType": "none",
"valType": "string"
},
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
"editType": "calc",
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lat": {
+ "description": "Sets the latitude coordinates (in degrees North).",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "latsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
"color": {
- "arrayOk": true,
- "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
"editType": "style",
"valType": "color"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
},
- "editType": "calc",
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
"role": "object",
- "width": {
- "arrayOk": true,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "dflt": 0,
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
"editType": "style",
- "min": 0,
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
"valType": "number"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
- "opacity": {
- "arrayOk": true,
- "description": "Sets the opacity of the bars.",
- "dflt": 1,
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
"editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "editType": "none",
"valType": "string"
- },
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
}
},
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "lon": {
+ "description": "Sets the longitude coordinates (in degrees East).",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "lonsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
+ "editType": "none",
+ "valType": "string"
+ },
"meta": {
"arrayOk": true,
"description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
@@ -35707,19 +35794,6 @@
"editType": "style",
"valType": "string"
},
- "offset": {
- "arrayOk": false,
- "description": "Shifts the position where the bar is drawn (in position axis units). In *group* barmode, traces that set *offset* will be excluded and drawn in *overlay* mode instead.",
- "dflt": null,
- "editType": "calc",
- "valType": "number"
- },
- "offsetgroup": {
- "description": "Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
"opacity": {
"description": "Sets the opacity of the trace.",
"dflt": 1,
@@ -35728,169 +35802,37 @@
"min": 0,
"valType": "number"
},
- "orientation": {
- "description": "Sets the orientation of the funnels. With *v* (*h*), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only *y* array is presented or orientation is set to *v*. Also regarding graphs including only 'horizontal' funnels, *autorange* on the *y-axis* are set to *reversed*.",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "v",
- "h"
- ]
+ "radius": {
+ "arrayOk": true,
+ "description": "Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymap trace smoother, but less detailed.",
+ "dflt": 30,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
},
- "outsidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "style",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `text` lying outside the bar.",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
+ "radiussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `radius`.",
+ "editType": "none",
+ "valType": "string"
},
- "selectedpoints": {
- "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
- "editType": "calc",
- "valType": "any"
+ "reversescale": {
+ "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
+ "dflt": false,
"editType": "style",
"valType": "boolean"
},
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
"stream": {
"editType": "calc",
"maxpoints": {
@@ -35910,596 +35852,445 @@
"valType": "string"
}
},
+ "subplot": {
+ "description": "Sets a reference between this trace's data coordinates and a map subplot. If *map* (the default value), the data refer to `layout.map`. If *map2*, the data refer to `layout.map2`, and so on.",
+ "dflt": "map",
+ "editType": "calc",
+ "valType": "subplotid"
+ },
"text": {
"arrayOk": true,
- "description": "Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "description": "Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"dflt": "",
"editType": "calc",
"valType": "string"
},
- "textangle": {
- "description": "Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With *auto* the texts may automatically be rotated to fit with the maximum size in bars.",
- "dflt": 0,
- "editType": "plot",
- "valType": "angle"
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
},
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "style",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
},
- "description": "Sets the font used for `text`.",
+ "role": "object"
+ },
+ "type": "densitymap",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
"editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ },
+ "z": {
+ "description": "Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "zauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "zmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "zauto": false
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "textinfo": {
- "arrayOk": false,
- "description": "Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "label",
- "text",
- "percent initial",
- "percent previous",
- "percent total",
- "value"
- ],
- "valType": "flaglist"
- },
- "textposition": {
- "arrayOk": true,
- "description": "Specifies the location of the `text`. *inside* positions `text` inside, next to the bar end (rotated and scaled if needed). *outside* positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. *auto* tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If *none*, no text appears.",
- "dflt": "auto",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "inside",
- "outside",
- "auto",
- "none"
- ]
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `percentInitial`, `percentPrevious`, `percentTotal`, `label` and `value`.",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
- },
- "type": "funnel",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
+ "valType": "number"
},
- "width": {
- "arrayOk": false,
- "description": "Sets the bar width (in position axis units).",
+ "zmid": {
+ "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
"dflt": null,
"editType": "calc",
- "min": 0,
+ "impliedEdits": {},
"valType": "number"
},
- "x": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "x0": {
- "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any"
- },
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "xperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "valType": "any"
- },
- "xperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "xperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
- "dflt": "middle",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "y": {
- "description": "Sets the y coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "y0": {
- "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any"
- },
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "yperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "valType": "any"
- },
- "yperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "yperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
- "dflt": "middle",
+ "zmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
+ "dflt": null,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
+ "impliedEdits": {
+ "zauto": false
+ },
+ "valType": "number"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
"editType": "none",
"valType": "string"
- },
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
}
},
"categories": [
- "bar-like",
- "cartesian",
- "svg",
- "oriented",
- "showLegend",
- "zoomScale"
+ "map",
+ "gl",
+ "showLegend"
],
- "layoutAttributes": {
- "funnelgap": {
- "description": "Sets the gap (in plot fraction) between bars of adjacent location coordinates.",
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "funnelgroupgap": {
- "description": "Sets the gap (in plot fraction) between bars of the same location coordinate.",
- "dflt": 0,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "funnelmode": {
- "description": "Determines how bars at the same location coordinate are displayed on the graph. With *stack*, the bars are stacked on top of one another With *group*, the bars are plotted next to one another centered around the shared location. With *overlay*, the bars are plotted over one another, you might need to reduce *opacity* to see multiple bars.",
- "dflt": "stack",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "stack",
- "group",
- "overlay"
- ]
- }
- },
"meta": {
- "description": "Visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a \"drop-off\" representation wherein each item appears in each stage it traversed. See also the \"funnelarea\" trace type for a different approach to visualizing funnel data."
+ "description": "Draws a bivariate kernel density estimation with a Gaussian kernel from `lon` and `lat` coordinates and optional `z` values using a colorscale.",
+ "hr_name": "density_map"
},
- "type": "funnel"
+ "type": "densitymap"
},
- "funnelarea": {
+ "densitymapbox": {
"animatable": false,
"attributes": {
- "aspectratio": {
- "description": "Sets the ratio between height and width",
- "dflt": 1,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "baseratio": {
- "description": "Sets the ratio between bottom length and maximum top length.",
- "dflt": 0.333,
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
"editType": "calc",
- "valType": "data_array"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
+ "below": {
+ "description": "Determines if the densitymapbox trace will be inserted before the layer with the specified ID. By default, densitymapbox traces are placed below the first layer of type symbol If set to '', the layer will be inserted above every existing layer.",
+ "editType": "plot",
"valType": "string"
},
- "dlabel": {
- "description": "Sets the label step. See `label0` for more info.",
- "dflt": 1,
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
"editType": "calc",
- "valType": "number"
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
},
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this funnelarea trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "editType": "calc",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this funnelarea trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "x": {
- "description": "Sets the horizontal domain of this funnelarea trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
},
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "y": {
- "description": "Sets the vertical domain of this funnelarea trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
"valType": "number"
- }
- ],
- "valType": "info_array"
- }
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "label",
- "text",
- "value",
- "percent",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "left",
- "right",
- "auto"
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
]
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
},
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
},
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
"valType": "color"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "editType": "none",
- "font": {
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "tickfont": {
"color": {
- "arrayOk": true,
- "editType": "none",
+ "editType": "colorbars",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
"lineposition": {
- "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "none",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -36510,56 +36301,32 @@
],
"valType": "flaglist"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
- "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "arrayOk": true,
- "editType": "none",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"style": {
- "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "none",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
"textcase": {
- "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "none",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -36568,16 +36335,10 @@
"lower"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -36588,16 +36349,10 @@
"unicase"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -36605,253 +36360,451 @@
"max": 1000,
"min": 1,
"valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
}
},
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `text` and `percent`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "insidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
},
- "description": "Sets the font used for `textinfo` lying inside the sector.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
"editType": "none",
"valType": "string"
},
- "size": {
- "arrayOk": true,
- "editType": "plot",
- "min": 1,
- "valType": "number"
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
"editType": "none",
"valType": "string"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "left",
+ "center",
+ "right"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "container",
+ "paper"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "top",
+ "middle",
+ "bottom"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
}
},
- "label0": {
- "description": "Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.",
- "dflt": 0,
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
- "valType": "number"
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
},
- "labels": {
- "description": "Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.",
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
"editType": "calc",
"valType": "data_array"
},
- "labelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
"editType": "none",
"valType": "string"
},
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "lon",
+ "lat",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
},
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
"valType": "string"
},
- "legendgrouptitle": {
- "editType": "style",
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
"font": {
"color": {
- "editType": "style",
+ "arrayOk": true,
+ "editType": "none",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
+ "editType": "none",
"noBlank": true,
"strict": true,
"valType": "string"
},
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
"lineposition": {
+ "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "style",
+ "editType": "none",
"extras": [
"none"
],
@@ -36862,32 +36815,56 @@
],
"valType": "flaglist"
},
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
"shadow": {
+ "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "style",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
"valType": "string"
},
"size": {
- "editType": "style",
+ "arrayOk": true,
+ "editType": "none",
"min": 1,
"valType": "number"
},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
"textcase": {
+ "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -36896,10 +36873,16 @@
"lower"
]
},
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -36910,10 +36893,16 @@
"unicase"
]
},
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -36921,447 +36910,104 @@
"max": 1000,
"min": 1,
"valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "marker": {
- "colors": {
- "description": "Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.",
- "editType": "calc",
- "valType": "data_array"
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
},
- "colorssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
"editType": "none",
"valType": "string"
},
- "editType": "calc",
- "line": {
- "color": {
- "arrayOk": true,
- "description": "Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.",
- "dflt": null,
- "editType": "style",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "role": "object",
- "width": {
- "arrayOk": true,
- "description": "Sets the width (in px) of the line enclosing each sector.",
- "dflt": 1,
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "pattern": {
- "bgcolor": {
- "arrayOk": true,
- "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
- "editType": "style",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the pattern within the marker.",
- "editType": "style",
- "fgcolor": {
- "arrayOk": true,
- "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
- "editType": "style",
- "valType": "color"
- },
- "fgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "fgopacity": {
- "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "fillmode": {
- "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
- "dflt": "replace",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "replace",
- "overlay"
- ]
- },
- "role": "object",
- "shape": {
- "arrayOk": true,
- "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
- "dflt": "",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "",
- "/",
- "\\",
- "x",
- "-",
- "|",
- "+",
- "."
- ]
- },
- "shapesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
- "dflt": 8,
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "solidity": {
- "arrayOk": true,
- "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
- "dflt": 0.3,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- }
- },
"role": "object"
},
- "meta": {
+ "hovertemplate": {
"arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
"editType": "none",
"valType": "string"
},
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
"valType": "string"
},
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "scalegroup": {
- "description": "If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.",
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
"dflt": "",
"editType": "calc",
"valType": "string"
},
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean"
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
},
- "stream": {
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
"editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "text": {
- "description": "Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "editType": "plot",
"valType": "data_array"
},
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `textinfo`.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
},
- "textinfo": {
- "description": "Determines which trace information appear on the graph.",
+ "lat": {
+ "description": "Sets the latitude coordinates (in degrees North).",
"editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "label",
- "text",
- "value",
- "percent"
- ],
- "valType": "flaglist"
- },
- "textposition": {
- "arrayOk": true,
- "description": "Specifies the location of the `textinfo`.",
- "dflt": "inside",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "inside",
- "none"
- ]
+ "valType": "data_array"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "latsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
"editType": "none",
"valType": "string"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
},
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `text` and `percent`.",
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
"dflt": "",
- "editType": "plot",
- "valType": "string"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
+ "editType": "style",
"valType": "string"
},
- "title": {
- "editType": "plot",
+ "legendgrouptitle": {
+ "editType": "style",
"font": {
"color": {
- "arrayOk": true,
- "editType": "plot",
+ "editType": "style",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "plot",
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
+ "editType": "style",
"noBlank": true,
"strict": true,
"valType": "string"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
"lineposition": {
- "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "plot",
+ "editType": "style",
"extras": [
"none"
],
@@ -37372,56 +37018,32 @@
],
"valType": "flaglist"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
- "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
+ "editType": "style",
"valType": "string"
},
"size": {
- "arrayOk": true,
- "editType": "plot",
+ "editType": "style",
"min": 1,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"style": {
- "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
"textcase": {
- "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -37430,16 +37052,10 @@
"lower"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -37450,16 +37066,10 @@
"unicase"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"extras": [
"normal",
"bold"
@@ -37467,438 +37077,409 @@
"max": 1000,
"min": 1,
"valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
}
},
- "position": {
- "description": "Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.",
- "dflt": "top center",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "top left",
- "top center",
- "top right"
- ]
- },
"role": "object",
"text": {
- "description": "Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "description": "Sets the title of the legend group.",
"dflt": "",
- "editType": "plot",
+ "editType": "style",
"valType": "string"
}
},
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
- },
- "type": "funnelarea",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
},
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
},
- "values": {
- "description": "Sets the values of the sectors. If omitted, we count occurrences of each label.",
+ "lon": {
+ "description": "Sets the longitude coordinates (in degrees East).",
"editType": "calc",
"valType": "data_array"
},
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
+ "lonsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
"editType": "none",
"valType": "string"
},
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- }
- },
- "categories": [
- "pie-like",
- "funnelarea",
- "showLegend"
- ],
- "layoutAttributes": {
- "extendfunnelareacolors": {
- "description": "If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.",
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "radius": {
+ "arrayOk": true,
+ "description": "Sets the radius of influence of one `lon` / `lat` point in pixels. Increasing the value makes the densitymapbox trace smoother, but less detailed.",
+ "dflt": 30,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "radiussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `radius`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": false,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
"dflt": true,
"editType": "calc",
"valType": "boolean"
},
- "funnelareacolorway": {
- "description": "Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`.",
+ "stream": {
"editType": "calc",
- "valType": "colorlist"
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
},
- "hiddenlabels": {
- "description": "hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts",
+ "subplot": {
+ "description": "mapbox subplots and traces are deprecated! Please consider switching to `map` subplots and traces. Learn more at: https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.",
+ "dflt": "mapbox",
+ "editType": "calc",
+ "valType": "subplotid"
+ },
+ "text": {
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
+ "type": "densitymapbox",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ },
+ "z": {
+ "description": "Sets the points' weight. For example, a value of 10 would be equivalent to having 10 points of weight 1 in the same spot",
"editType": "calc",
"valType": "data_array"
},
- "hiddenlabelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hiddenlabels`.",
+ "zauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "zmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "zauto": false
+ },
+ "valType": "number"
+ },
+ "zmid": {
+ "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "zmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "zauto": false
+ },
+ "valType": "number"
+ },
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
"editType": "none",
"valType": "string"
}
},
+ "categories": [
+ "mapbox",
+ "gl",
+ "showLegend"
+ ],
"meta": {
- "description": "Visualize stages in a process using area-encoded trapezoids. This trace can be used to show data in a part-to-whole representation similar to a \"pie\" trace, wherein each item appears in a single stage. See also the \"funnel\" trace type for a different approach to visualizing funnel data."
+ "description": "*densitymapbox* trace is deprecated! Please consider switching to the *densitymap* trace type and `map` subplots. Learn more at: https://plotly.com/javascript/maplibre-migration/ Draws a bivariate kernel density estimation with a Gaussian kernel from `lon` and `lat` coordinates and optional `z` values using a colorscale.",
+ "hr_name": "density_mapbox"
},
- "type": "funnelarea"
+ "type": "densitymapbox"
},
- "heatmap": {
+ "funnel": {
"animatable": false,
"attributes": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": false,
+ "alignmentgroup": {
+ "description": "Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.",
+ "dflt": "",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "string"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "cliponaxis": {
+ "description": "Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
},
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "connector": {
+ "editType": "plot",
+ "fillcolor": {
+ "description": "Sets the fill color.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
+ "dflt": "#444",
+ "editType": "style",
+ "valType": "color"
},
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
+ "dash": {
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
+ "dflt": "solid",
+ "editType": "style",
+ "valType": "string",
"values": [
- "right",
- "top",
- "bottom"
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
]
- }
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
},
- "valType": "any"
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ }
},
- "editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
+ "role": "object",
+ "visible": {
+ "description": "Determines if connector regions and lines are drawn.",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ }
+ },
+ "constraintext": {
+ "description": "Constrain the size of text inside or outside a bar to be no larger than the bar itself.",
+ "dflt": "both",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "outside",
+ "both",
+ "none"
+ ]
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "dx": {
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "dy": {
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "name",
+ "x",
+ "y",
+ "text",
+ "percent initial",
+ "percent previous",
+ "percent total"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
+ "left",
+ "right",
+ "auto"
]
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
},
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
},
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
},
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
},
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "integer"
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
},
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "tickfont": {
+ "editType": "none",
+ "font": {
"color": {
- "editType": "colorbars",
+ "arrayOk": true,
+ "editType": "none",
"valType": "color"
},
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
+ "editType": "none",
"noBlank": true,
"strict": true,
"valType": "string"
},
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
"lineposition": {
+ "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "none",
"extras": [
"none"
],
@@ -37909,32 +37490,56 @@
],
"valType": "flaglist"
},
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
"shadow": {
+ "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
"valType": "string"
},
"size": {
- "editType": "colorbars",
+ "arrayOk": true,
+ "editType": "none",
"min": 1,
"valType": "number"
},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
"textcase": {
+ "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -37943,10 +37548,16 @@
"lower"
]
},
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -37957,10 +37568,16 @@
"unicase"
]
},
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -37968,639 +37585,216 @@
"max": 1000,
"min": 1,
"valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
"valType": "string"
},
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
- },
- "role": "object"
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `percentInitial`, `percentPrevious` and `percentTotal`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "insidetextanchor": {
+ "description": "Determines if texts are kept at center or start/end points in `textposition` *inside* mode.",
+ "dflt": "middle",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "end",
+ "middle",
+ "start"
+ ]
+ },
+ "insidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "style",
+ "valType": "color"
},
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
+ "description": "Sets the font used for `text` lying inside the bar.",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 1,
- "valType": "integer"
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
"valType": "number"
},
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
- "impliedEdits": {},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "auto",
- "linear",
- "array"
+ "normal",
+ "italic"
]
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
"valType": "string"
},
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "colorbars",
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
"valType": "string"
},
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
"editType": "none",
"valType": "string"
},
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
"editType": "none",
"valType": "string"
- },
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
- "valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "top",
- "middle",
- "bottom"
- ]
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
}
},
- "colorscale": {
- "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array and `zsmooth` is not false; otherwise it is defaulted to false.",
- "editType": "calc",
- "valType": "boolean"
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "dx": {
- "description": "Sets the x coordinate step. See `x0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "number"
- },
- "dy": {
- "description": "Sets the y coordinate step. See `y0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "number"
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
- },
- "hoverongaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "description": "Same as `text`.",
- "editType": "calc",
- "valType": "data_array"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"legend": {
"description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
"dflt": "legend",
@@ -38724,566 +37918,398 @@
"min": 0,
"valType": "number"
},
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "reversescale": {
- "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "style",
- "valType": "boolean"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
+ "marker": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
"editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
+ "dflt": true,
"editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "text": {
- "description": "Sets the text elements associated with each z value.",
- "editType": "calc",
- "valType": "data_array"
- },
- "textfont": {
- "color": {
- "dflt": "auto",
- "editType": "style",
- "valType": "color"
- },
- "description": "Sets the text font.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "size": {
- "dflt": "auto",
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
+ "dflt": null,
"editType": "plot",
- "min": 1,
+ "impliedEdits": {
+ "cauto": false
+ },
"valType": "number"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
+ "dflt": null,
"editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- },
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
- },
- "transpose": {
- "description": "Transposes the z data.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "type": "heatmap",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- },
- "x": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "xtype": "array"
- },
- "valType": "data_array"
- },
- "x0": {
- "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "any"
- },
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "xgap": {
- "description": "Sets the horizontal gap (in pixels) between bricks.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "xperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "any"
- },
- "xperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "any"
- },
- "xperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
- "dflt": "middle",
- "editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "xtype": {
- "description": "If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "array",
- "scaled"
- ]
- },
- "y": {
- "description": "Sets the y coordinates.",
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "ytype": "array"
- },
- "valType": "data_array"
- },
- "y0": {
- "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "any"
- },
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "ycalendar": {
- "description": "Sets the calendar system to use with `y` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "ygap": {
- "description": "Sets the vertical gap (in pixels) between bricks.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "yperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "any"
- },
- "yperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "any"
- },
- "yperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
- "dflt": "middle",
- "editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
},
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "ytype": {
- "description": "If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "array",
- "scaled"
- ]
- },
- "z": {
- "description": "Sets the z data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "zauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "zhoverformat": {
- "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "zmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "zauto": false
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
+ "editType": "style",
+ "valType": "color"
},
- "valType": "number"
- },
- "zmid": {
- "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "zmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "zauto": false
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
},
- "valType": "number"
- },
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
- },
- "zsmooth": {
- "description": "Picks a smoothing algorithm use to smooth `z` data.",
- "dflt": false,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fast",
- "best",
- false
- ]
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "categories": [
- "cartesian",
- "svg",
- "2dMap",
- "showLegend"
- ],
- "meta": {
- "description": "The data that describes the heatmap value-to-color mapping is set in `z`. Data in `z` can either be a {2D array} of values (ragged or not) or a 1D array of values. In the case where `z` is a {2D array}, say that `z` has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in `z` is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using `transpose`. Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) elements. If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where `z` is a 1D {array}, the x and y coordinates must be provided in `x` and `y` respectively to form data triplets."
- },
- "type": "heatmap"
- },
- "heatmapgl": {
- "animatable": false,
- "attributes": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": false,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "calc",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
"valType": "string"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -39293,7 +38319,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -39305,7 +38331,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -39319,7 +38345,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -39329,1044 +38355,664 @@
"valType": "integer"
}
},
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "calc",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "right",
- "top",
- "bottom"
+ "allow",
+ "hide past div",
+ "hide past domain"
]
- }
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "calc",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
},
- "valType": "any"
- },
- "editType": "calc",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
- },
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "calc",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
},
- "valType": "any"
- },
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "calc",
- "valType": "angle"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
- },
- "tickfont": {
- "color": {
- "editType": "calc",
- "valType": "color"
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
},
- "description": "Sets the color bar's tick label font",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
},
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "size": {
- "editType": "calc",
- "min": 1,
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "left",
+ "center",
+ "right"
]
},
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "container",
+ "paper"
]
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "top",
+ "middle",
+ "bottom"
]
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "valType": "any"
- },
- {
- "editType": "calc",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "calc",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "calc",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- }
- }
+ "impliedEdits": {
+ "autocolorscale": false
},
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
- },
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "calc",
- "min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "calc",
- "impliedEdits": {},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ]
+ "valType": "colorscale"
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "calc",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
"valType": "string"
},
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- ""
- ]
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "calc",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "calc",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "title": {
- "editType": "calc",
- "font": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "calc",
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
"editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "valType": "number"
},
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
},
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
"valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "calc",
- "valType": "number"
- },
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ },
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "calc",
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the opacity of the bars.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "calc",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "top",
- "middle",
- "bottom"
- ]
+ "opacitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "editType": "none",
+ "valType": "string"
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
},
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
+ "role": "object",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
+ "dflt": false,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
+ "valType": "boolean"
}
},
- "colorscale": {
- "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
"editType": "none",
"valType": "string"
},
- "dx": {
- "description": "Sets the x coordinate step. See `x0` for more info.",
- "dflt": 1,
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "offset": {
+ "arrayOk": false,
+ "description": "Shifts the position where the bar is drawn (in position axis units). In *group* barmode, traces that set *offset* will be excluded and drawn in *overlay* mode instead.",
+ "dflt": null,
"editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
"valType": "number"
},
- "dy": {
- "description": "Sets the y coordinate step. See `y0` for more info.",
- "dflt": 1,
+ "offsetgroup": {
+ "description": "Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.",
+ "dflt": "",
"editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
- },
- "valType": "number"
+ "valType": "string"
},
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "orientation": {
+ "description": "Sets the orientation of the funnels. With *v* (*h*), the value of the each bar spans along the vertical (horizontal). By default funnels are tend to be oriented horizontally; unless only *y* array is presented or orientation is set to *v*. Also regarding graphs including only 'horizontal' funnels, *autorange* on the *y-axis* are set to *reversed*.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "enumerated",
+ "values": [
+ "v",
+ "h"
+ ]
},
- "hoverlabel": {
- "align": {
+ "outsidetextfont": {
+ "color": {
"arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
+ "editType": "style",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
+ "valType": "string"
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "description": "Sets the font used for `text` lying outside the bar.",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
"editType": "none",
"valType": "string"
},
- "bgcolor": {
+ "lineposition": {
"arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
"editType": "none",
- "valType": "color"
+ "valType": "string"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
"editType": "none",
"valType": "string"
},
- "bordercolor": {
+ "size": {
"arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
"editType": "none",
- "valType": "color"
+ "valType": "string"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
"editType": "none",
"valType": "string"
},
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
"editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
+ "valType": "string"
},
- "namelength": {
+ "variant": {
"arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
"editType": "none",
"valType": "string"
},
- "role": "object"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color"
- },
- "description": "Sets this legend group's title font.",
- "editType": "style",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "style",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "style",
- "valType": "string"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
"valType": "string"
}
},
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "reversescale": {
- "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
- "dflt": false,
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
"editType": "calc",
- "valType": "boolean"
+ "valType": "any"
},
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": true,
- "editType": "calc",
+ "editType": "style",
"valType": "boolean"
},
"stream": {
@@ -40389,15 +39035,213 @@
}
},
"text": {
- "description": "Sets the text elements associated with each z value.",
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
"editType": "calc",
- "valType": "data_array"
+ "valType": "string"
+ },
+ "textangle": {
+ "description": "Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With *auto* the texts may automatically be rotated to fit with the maximum size in bars.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "angle"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "style",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used for `text`.",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "textinfo": {
+ "arrayOk": false,
+ "description": "Determines which trace information appear on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace).",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "percent initial",
+ "percent previous",
+ "percent total",
+ "value"
+ ],
+ "valType": "flaglist"
+ },
+ "textposition": {
+ "arrayOk": true,
+ "description": "Specifies the location of the `text`. *inside* positions `text` inside, next to the bar end (rotated and scaled if needed). *outside* positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. *auto* tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If *none*, no text appears.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "outside",
+ "auto",
+ "none"
+ ]
+ },
+ "textpositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "editType": "none",
+ "valType": "string"
},
"textsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `text`.",
"editType": "none",
"valType": "string"
},
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `percentInitial`, `percentPrevious`, `percentTotal`, `label` and `value`.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
"transforms": {
"items": {
"transform": {
@@ -40408,13 +39252,7 @@
},
"role": "object"
},
- "transpose": {
- "description": "Transposes the z data.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "type": "heatmapgl",
+ "type": "funnel",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -40436,21 +39274,23 @@
"legendonly"
]
},
+ "width": {
+ "arrayOk": false,
+ "description": "Sets the bar width (in position axis units).",
+ "dflt": null,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
"x": {
"description": "Sets the x coordinates.",
- "editType": "calc",
- "impliedEdits": {
- "xtype": "array"
- },
+ "editType": "calc+clearAxisTypes",
"valType": "data_array"
},
"x0": {
"description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
"dflt": 0,
- "editType": "calc",
- "impliedEdits": {
- "xtype": "scaled"
- },
+ "editType": "calc+clearAxisTypes",
"valType": "any"
},
"xaxis": {
@@ -40459,35 +39299,48 @@
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
"editType": "none",
"valType": "string"
},
- "xtype": {
- "description": "If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).",
+ "xperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "xperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "xperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
+ "dflt": "middle",
"editType": "calc",
"valType": "enumerated",
"values": [
- "array",
- "scaled"
+ "start",
+ "middle",
+ "end"
]
},
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
+ "valType": "string"
+ },
"y": {
"description": "Sets the y coordinates.",
- "editType": "calc",
- "impliedEdits": {
- "ytype": "array"
- },
+ "editType": "calc+clearAxisTypes",
"valType": "data_array"
},
"y0": {
"description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
"dflt": 0,
- "editType": "calc",
- "impliedEdits": {
- "ytype": "scaled"
- },
+ "editType": "calc+clearAxisTypes",
"valType": "any"
},
"yaxis": {
@@ -40496,169 +39349,104 @@
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
"editType": "none",
"valType": "string"
},
- "ytype": {
- "description": "If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)",
+ "yperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "array",
- "scaled"
- ]
+ "valType": "any"
},
- "z": {
- "description": "Sets the z data.",
+ "yperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
"editType": "calc",
- "valType": "data_array"
+ "valType": "any"
},
- "zauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
- "dflt": true,
+ "yperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
+ "dflt": "middle",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
},
- "zmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "zauto": false
- },
- "valType": "number"
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
+ "valType": "string"
},
- "zmid": {
- "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
- "dflt": null,
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ }
+ },
+ "categories": [
+ "bar-like",
+ "cartesian",
+ "svg",
+ "oriented",
+ "showLegend",
+ "zoomScale"
+ ],
+ "layoutAttributes": {
+ "funnelgap": {
+ "description": "Sets the gap (in plot fraction) between bars of adjacent location coordinates.",
"editType": "calc",
- "impliedEdits": {},
+ "max": 1,
+ "min": 0,
"valType": "number"
},
- "zmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
- "dflt": null,
+ "funnelgroupgap": {
+ "description": "Sets the gap (in plot fraction) between bars of the same location coordinate.",
+ "dflt": 0,
"editType": "calc",
- "impliedEdits": {
- "zauto": false
- },
+ "max": 1,
+ "min": 0,
"valType": "number"
},
- "zsmooth": {
- "description": "Picks a smoothing algorithm use to smooth `z` data.",
- "dflt": "fast",
+ "funnelmode": {
+ "description": "Determines how bars at the same location coordinate are displayed on the graph. With *stack*, the bars are stacked on top of one another With *group*, the bars are plotted next to one another centered around the shared location. With *overlay*, the bars are plotted over one another, you might need to reduce *opacity* to see multiple bars.",
+ "dflt": "stack",
"editType": "calc",
"valType": "enumerated",
"values": [
- "fast",
- false
+ "stack",
+ "group",
+ "overlay"
]
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
}
},
- "categories": [
- "gl",
- "gl2d",
- "2dMap"
- ],
"meta": {
- "description": "*heatmapgl* trace is deprecated! Please consider switching to the *heatmap* or *image* trace types. Alternatively you could contribute/sponsor rewriting this trace type based on cartesian features and using regl framework. WebGL version of the heatmap trace type."
+ "description": "Visualize stages in a process using length-encoded bars. This trace can be used to show data in either a part-to-whole representation wherein each item appears in a single stage, or in a \"drop-off\" representation wherein each item appears in each stage it traversed. See also the \"funnelarea\" trace type for a different approach to visualizing funnel data."
},
- "type": "heatmapgl"
+ "type": "funnel"
},
- "histogram": {
+ "funnelarea": {
"animatable": false,
"attributes": {
- "_deprecated": {
- "bardir": {
- "description": "Renamed to `orientation`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "v",
- "h"
- ]
- }
- },
- "alignmentgroup": {
- "description": "Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "autobinx": {
- "description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.",
- "dflt": null,
- "editType": "calc",
- "valType": "boolean"
- },
- "autobiny": {
- "description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.",
- "dflt": null,
- "editType": "calc",
- "valType": "boolean"
- },
- "bingroup": {
- "description": "Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same *orientation* under `barmode` *stack*, *relative* and *group* are forced into the same bingroup, Using `bingroup`, traces under `barmode` *overlay* and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup`",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "cliponaxis": {
- "description": "Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.",
- "dflt": true,
+ "aspectratio": {
+ "description": "Sets the ratio between height and width",
+ "dflt": 1,
"editType": "plot",
- "valType": "boolean"
- },
- "constraintext": {
- "description": "Constrain the size of text inside or outside a bar to be no larger than the bar itself.",
- "dflt": "both",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "inside",
- "outside",
- "both",
- "none"
- ]
+ "min": 0,
+ "valType": "number"
},
- "cumulative": {
- "currentbin": {
- "description": "Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. *include* is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. *exclude* makes the opposite half-bin bias, and *half* removes it.",
- "dflt": "include",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "include",
- "exclude",
- "half"
- ]
- },
- "direction": {
- "description": "Only applies if cumulative is enabled. If *increasing* (default) we sum all prior bins, so the result increases from left to right. If *decreasing* we sum later bins so the result decreases from left to right.",
- "dflt": "increasing",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "increasing",
- "decreasing"
- ]
- },
- "editType": "calc",
- "enabled": {
- "description": "If true, display the cumulative distribution by summing the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the *density* `histnorm` settings behave the same as their equivalents without *density*: ** and *density* both rise to the number of data points, and *probability* and *probability density* both rise to the number of sample points.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "role": "object"
+ "baseratio": {
+ "description": "Sets the ratio between bottom length and maximum top length.",
+ "dflt": 0.333,
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
"customdata": {
"description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
@@ -40670,291 +39458,139 @@
"editType": "none",
"valType": "string"
},
- "error_x": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "style",
- "valType": "number"
- }
- },
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
- "editType": "none",
- "valType": "string"
- },
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
- "editType": "none",
- "valType": "string"
- },
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "style",
- "valType": "color"
- },
- "copy_ystyle": {
- "editType": "plot",
- "valType": "boolean"
- },
+ "dlabel": {
+ "description": "Sets the label step. See `label0` for more info.",
+ "dflt": 1,
"editType": "calc",
- "role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "traceref": {
+ "valType": "number"
+ },
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this funnelarea trace .",
"dflt": 0,
- "editType": "style",
+ "editType": "calc",
"min": 0,
"valType": "integer"
},
- "tracerefminus": {
+ "editType": "calc",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this funnelarea trace .",
"dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer"
- },
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "percent",
- "constant",
- "sqrt",
- "data"
- ]
- },
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
"editType": "calc",
"min": 0,
- "valType": "number"
+ "valType": "integer"
},
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
+ "x": {
+ "description": "Sets the horizontal domain of this funnelarea trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
"editType": "calc",
- "min": 0,
- "valType": "number"
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
},
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
+ "y": {
+ "description": "Sets the vertical domain of this funnelarea trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
"editType": "calc",
- "valType": "boolean"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "plot",
- "min": 0,
- "valType": "number"
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
}
},
- "error_y": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "style",
- "valType": "number"
- }
- },
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "value",
+ "percent",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
"editType": "none",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
},
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
"editType": "none",
"valType": "string"
},
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "style",
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
"valType": "color"
},
- "editType": "calc",
- "role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number"
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
},
- "traceref": {
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer"
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
},
- "tracerefminus": {
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer"
- },
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "percent",
- "constant",
- "sqrt",
- "data"
- ]
- },
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "plot",
- "min": 0,
- "valType": "number"
- }
- },
- "histfunc": {
- "description": "Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.",
- "dflt": "count",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "count",
- "sum",
- "avg",
- "min",
- "max"
- ]
- },
- "histnorm": {
- "description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
- "dflt": "",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "",
- "percent",
- "probability",
- "density",
- "probability density"
- ]
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
},
"editType": "none",
"font": {
@@ -41117,7 +39753,7 @@
},
"hovertemplate": {
"arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `binNumber` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `text` and `percent`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
"dflt": "",
"editType": "none",
"valType": "string"
@@ -41129,7 +39765,7 @@
},
"hovertext": {
"arrayOk": true,
- "description": "Same as `text`.",
+ "description": "Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.",
"dflt": "",
"editType": "style",
"valType": "string"
@@ -41149,32 +39785,34 @@
"editType": "none",
"valType": "string"
},
- "insidetextanchor": {
- "description": "Determines if texts are kept at center or start/end points in `textposition` *inside* mode.",
- "dflt": "end",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "end",
- "middle",
- "start"
- ]
- },
"insidetextfont": {
"color": {
- "editType": "style",
+ "arrayOk": true,
+ "editType": "plot",
"valType": "color"
},
- "description": "Sets the font used for `text` lying inside the bar.",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used for `textinfo` lying inside the sector.",
"editType": "plot",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string"
},
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
"lineposition": {
+ "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
"editType": "plot",
@@ -41188,19 +39826,37 @@
],
"valType": "flaglist"
},
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
"shadow": {
+ "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
"editType": "plot",
"valType": "string"
},
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
"size": {
+ "arrayOk": true,
"editType": "plot",
"min": 1,
"valType": "number"
},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
"editType": "plot",
@@ -41210,7 +39866,13 @@
"italic"
]
},
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
"textcase": {
+ "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
"editType": "plot",
@@ -41222,7 +39884,13 @@
"lower"
]
},
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
"editType": "plot",
@@ -41236,7 +39904,13 @@
"unicase"
]
},
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
"editType": "plot",
@@ -41247,8 +39921,29 @@
"max": 1000,
"min": 1,
"valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
+ "label0": {
+ "description": "Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "labels": {
+ "description": "Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "labelssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
+ "editType": "none",
+ "valType": "string"
+ },
"legend": {
"description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
"dflt": "legend",
@@ -41373,391 +40068,692 @@
"valType": "number"
},
"marker": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
+ "colors": {
+ "description": "Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "data_array"
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "colorssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
+ "editType": "none",
+ "valType": "string"
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
+ "editType": "calc",
+ "line": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.",
+ "dflt": null,
+ "editType": "style",
+ "valType": "color"
},
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "valType": "number"
- },
- "color": {
- "arrayOk": true,
- "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
- "editType": "style",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
"editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- }
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the line enclosing each sector.",
+ "dflt": 1,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
},
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "pattern": {
"bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
+ "editType": "style",
"valType": "color"
},
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the pattern within the marker.",
+ "editType": "style",
+ "fgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
+ "editType": "style",
"valType": "color"
},
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
+ "fgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "fgopacity": {
+ "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
+ "editType": "style",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
+ "fillmode": {
+ "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
+ "dflt": "replace",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
+ "replace",
+ "overlay"
]
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
+ "role": "object",
+ "shape": {
+ "arrayOk": true,
+ "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
+ "dflt": "",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "",
+ "/",
+ "\\",
+ "x",
+ "-",
+ "|",
+ "+",
+ "."
]
},
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "shapesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
+ "editType": "none",
+ "valType": "string"
},
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
+ "dflt": 8,
+ "editType": "style",
"min": 0,
- "valType": "integer"
+ "valType": "number"
},
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
+ "solidity": {
+ "arrayOk": true,
+ "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
+ "dflt": 0.3,
+ "editType": "style",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean"
+ "soliditysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "role": "object"
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "scalegroup": {
+ "description": "If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "text": {
+ "description": "Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "editType": "plot",
+ "valType": "data_array"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used for `textinfo`.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "textinfo": {
+ "description": "Determines which trace information appear on the graph.",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "value",
+ "percent"
+ ],
+ "valType": "flaglist"
+ },
+ "textposition": {
+ "arrayOk": true,
+ "description": "Specifies the location of the `textinfo`.",
+ "dflt": "inside",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "none"
+ ]
+ },
+ "textpositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `text` and `percent`.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "title": {
+ "editType": "plot",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
},
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
"none"
- ]
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
},
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "italic"
]
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
},
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
},
- "tickfont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "position": {
+ "description": "Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.",
+ "dflt": "top center",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right"
+ ]
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ }
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
+ "type": "funnelarea",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "values": {
+ "description": "Sets the values of the sectors. If omitted, we count occurrences of each label.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "valuessrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `values`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ }
+ },
+ "categories": [
+ "pie-like",
+ "funnelarea",
+ "showLegend"
+ ],
+ "layoutAttributes": {
+ "extendfunnelareacolors": {
+ "description": "If `true`, the funnelarea slice colors (whether given by `funnelareacolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "funnelareacolorway": {
+ "description": "Sets the default funnelarea slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendfunnelareacolors`.",
+ "editType": "calc",
+ "valType": "colorlist"
+ },
+ "hiddenlabels": {
+ "description": "hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "hiddenlabelssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hiddenlabels`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "meta": {
+ "description": "Visualize stages in a process using area-encoded trapezoids. This trace can be used to show data in a part-to-whole representation similar to a \"pie\" trace, wherein each item appears in a single stage. See also the \"funnel\" trace type for a different approach to visualizing funnel data."
+ },
+ "type": "funnelarea"
+ },
+ "heatmap": {
+ "animatable": false,
+ "attributes": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": false,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
"valType": "number"
},
"style": {
@@ -41809,564 +40805,1049 @@
"valType": "integer"
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "allow",
- "hide past div",
- "hide past domain"
+ "right",
+ "top",
+ "bottom"
]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
},
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "tickfont": {
+ "color": {
"editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
+ "valType": "color"
},
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "colorbars",
- "min": 1,
- "valType": "integer"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
"editType": "colorbars",
- "min": 0,
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
"valType": "number"
},
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "colorbars",
- "impliedEdits": {},
"valType": "enumerated",
"values": [
- "auto",
- "linear",
- "array"
+ "normal",
+ "italic"
]
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "colorbars",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "title": {
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "colorbars",
- "font": {
- "color": {
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
"editType": "colorbars",
- "valType": "color"
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
},
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
"editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
"editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "valType": "boolean"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
"editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "valType": "string"
},
"role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
"editType": "colorbars",
"valType": "string"
},
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
"editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "valType": "string"
}
+ }
+ },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
+ },
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
"role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "right",
- "top",
- "bottom"
+ "normal",
+ "italic"
]
},
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "colorbars",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
+ "right",
"top",
- "middle",
"bottom"
]
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
"editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
+ "valType": "string"
}
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
},
- "cornerradius": {
- "description": "Sets the rounding of corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %). Defaults to `layout.barcornerradius`. In stack or relative barmode, the first trace to set cornerradius is used for the whole stack.",
- "editType": "calc",
- "valType": "any"
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in. It is defaulted to true if `z` is a one dimensional array and `zsmooth` is not false; otherwise it is defaulted to false.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "dx": {
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "number"
+ },
+ "dy": {
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "number"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
"color": {
"arrayOk": true,
- "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
- "editType": "style",
+ "editType": "none",
"valType": "color"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
"colorsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
"valType": "string"
},
- "editType": "calc",
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
},
"role": "object",
- "width": {
+ "shadow": {
"arrayOk": true,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "dflt": 0,
- "editType": "style",
- "min": 0,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
"valType": "number"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
"editType": "none",
"valType": "string"
}
},
- "opacity": {
+ "namelength": {
"arrayOk": true,
- "description": "Sets the opacity of the bars.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
},
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
"editType": "none",
"valType": "string"
},
- "pattern": {
- "bgcolor": {
- "arrayOk": true,
- "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
+ "role": "object"
+ },
+ "hoverongaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data have hover labels associated with them.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "description": "Same as `text`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
"editType": "style",
"valType": "color"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
},
- "description": "Sets the pattern within the marker.",
- "editType": "style",
- "fgcolor": {
- "arrayOk": true,
- "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
"editType": "style",
- "valType": "color"
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "fgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
- "editType": "none",
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
"valType": "string"
},
- "fgopacity": {
- "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
+ "size": {
"editType": "style",
- "max": 1,
- "min": 0,
+ "min": 1,
"valType": "number"
},
- "fillmode": {
- "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
- "dflt": "replace",
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "style",
"valType": "enumerated",
"values": [
- "replace",
- "overlay"
+ "normal",
+ "italic"
]
},
- "role": "object",
- "shape": {
- "arrayOk": true,
- "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
- "dflt": "",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "style",
"valType": "enumerated",
"values": [
- "",
- "/",
- "\\",
- "x",
- "-",
- "|",
- "+",
- "."
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "shapesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
- "dflt": 8,
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "style",
- "min": 0,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "solidity": {
- "arrayOk": true,
- "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
- "dflt": 0.3,
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
"role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
}
},
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
"meta": {
"arrayOk": true,
"description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
@@ -42383,26 +41864,6 @@
"editType": "style",
"valType": "string"
},
- "nbinsx": {
- "description": "Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "nbinsy": {
- "description": "Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "offsetgroup": {
- "description": "Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
"opacity": {
"description": "Sets the opacity of the trace.",
"dflt": 1,
@@ -42411,144 +41872,24 @@
"min": 0,
"valType": "number"
},
- "orientation": {
- "description": "Sets the orientation of the bars. With *v* (*h*), the value of the each bar spans along the vertical (horizontal).",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "v",
- "h"
- ]
- },
- "outsidetextfont": {
- "color": {
- "editType": "style",
- "valType": "color"
- },
- "description": "Sets the font used for `text` lying outside the bar.",
+ "reversescale": {
+ "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
+ "dflt": false,
"editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "selected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of selected points.",
- "editType": "style",
- "valType": "color"
- },
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object"
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of selected points.",
- "editType": "style",
- "valType": "color"
- },
- "editType": "style",
- "role": "object"
- }
- },
- "selectedpoints": {
- "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
- "editType": "calc",
- "valType": "any"
+ "valType": "boolean"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
+ "dflt": false,
"editType": "style",
"valType": "boolean"
},
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
"stream": {
"editType": "calc",
"maxpoints": {
@@ -42569,20 +41910,13 @@
}
},
"text": {
- "arrayOk": true,
- "description": "Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.",
- "dflt": "",
+ "description": "Sets the text elements associated with each z value.",
"editType": "calc",
- "valType": "string"
- },
- "textangle": {
- "description": "Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With *auto* the texts may automatically be rotated to fit with the maximum size in bars.",
- "dflt": "auto",
- "editType": "plot",
- "valType": "angle"
+ "valType": "data_array"
},
"textfont": {
"color": {
+ "dflt": "auto",
"editType": "style",
"valType": "color"
},
@@ -42617,6 +41951,7 @@
"valType": "string"
},
"size": {
+ "dflt": "auto",
"editType": "plot",
"min": 1,
"valType": "number"
@@ -42670,26 +42005,13 @@
"valType": "integer"
}
},
- "textposition": {
- "arrayOk": false,
- "description": "Specifies the location of the `text`. *inside* positions `text` inside, next to the bar end (rotated and scaled if needed). *outside* positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. *auto* tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If *none*, no text appears.",
- "dflt": "auto",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "inside",
- "outside",
- "auto",
- "none"
- ]
- },
"textsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `text`.",
"editType": "none",
"valType": "string"
},
"texttemplate": {
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label` and `value`.",
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.",
"dflt": "",
"editType": "plot",
"valType": "string"
@@ -42704,7 +42026,13 @@
},
"role": "object"
},
- "type": "histogram",
+ "transpose": {
+ "description": "Transposes the z data.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "type": "heatmap",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -42715,35 +42043,6 @@
"editType": "none",
"valType": "any"
},
- "unselected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color"
- },
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object"
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color"
- },
- "editType": "style",
- "role": "object"
- }
- },
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
"dflt": true,
@@ -42756,35 +42055,28 @@
]
},
"x": {
- "description": "Sets the sample data to be binned on the x axis.",
+ "description": "Sets the x coordinates.",
"editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "xtype": "array"
+ },
"valType": "data_array"
},
+ "x0": {
+ "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "any"
+ },
"xaxis": {
"description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
"dflt": "x",
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "xbins": {
- "editType": "calc",
- "end": {
- "description": "Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.",
- "editType": "calc",
- "valType": "any"
- },
- "role": "object",
- "size": {
- "description": "Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.",
- "editType": "calc",
- "valType": "any"
- },
- "start": {
- "description": "Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.",
- "editType": "calc",
- "valType": "any"
- }
- },
"xcalendar": {
"description": "Sets the calendar system to use with `x` date data.",
"dflt": "gregorian",
@@ -42809,47 +42101,87 @@
"ummalqura"
]
},
+ "xgap": {
+ "description": "Sets the horizontal gap (in pixels) between bricks.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
"xhoverformat": {
"description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
"dflt": "",
"editType": "none",
"valType": "string"
},
+ "xperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "any"
+ },
+ "xperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "any"
+ },
+ "xperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
+ "dflt": "middle",
+ "editType": "calc",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
+ },
"xsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `x`.",
"editType": "none",
"valType": "string"
},
+ "xtype": {
+ "description": "If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).",
+ "editType": "calc+clearAxisTypes",
+ "valType": "enumerated",
+ "values": [
+ "array",
+ "scaled"
+ ]
+ },
"y": {
- "description": "Sets the sample data to be binned on the y axis.",
+ "description": "Sets the y coordinates.",
"editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "ytype": "array"
+ },
"valType": "data_array"
},
+ "y0": {
+ "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "any"
+ },
"yaxis": {
"description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
"dflt": "y",
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "ybins": {
- "editType": "calc",
- "end": {
- "description": "Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.",
- "editType": "calc",
- "valType": "any"
- },
- "role": "object",
- "size": {
- "description": "Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.",
- "editType": "calc",
- "valType": "any"
- },
- "start": {
- "description": "Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.",
- "editType": "calc",
- "valType": "any"
- }
- },
"ycalendar": {
"description": "Sets the calendar system to use with `y` date data.",
"dflt": "gregorian",
@@ -42874,99 +42206,144 @@
"ummalqura"
]
},
+ "ygap": {
+ "description": "Sets the vertical gap (in pixels) between bricks.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
"yhoverformat": {
"description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
"dflt": "",
"editType": "none",
"valType": "string"
},
+ "yperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "any"
+ },
+ "yperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "any"
+ },
+ "yperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
+ "dflt": "middle",
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
+ },
"ysrc": {
"description": "Sets the source reference on Chart Studio Cloud for `y`.",
"editType": "none",
"valType": "string"
},
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
- }
- },
- "categories": [
- "bar-like",
- "cartesian",
- "svg",
- "bar",
- "histogram",
- "oriented",
- "errorBarsOK",
- "showLegend"
- ],
- "layoutAttributes": {
- "barcornerradius": {
- "description": "Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).",
+ "ytype": {
+ "description": "If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)",
+ "editType": "calc+clearAxisTypes",
+ "valType": "enumerated",
+ "values": [
+ "array",
+ "scaled"
+ ]
+ },
+ "z": {
+ "description": "Sets the z data.",
"editType": "calc",
- "valType": "any"
+ "valType": "data_array"
},
- "bargap": {
- "description": "Sets the gap (in plot fraction) between bars of adjacent location coordinates.",
+ "zauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
+ "dflt": true,
"editType": "calc",
- "max": 1,
- "min": 0,
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "zmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "zauto": false
+ },
"valType": "number"
},
- "bargroupgap": {
- "description": "Sets the gap (in plot fraction) between bars of the same location coordinate.",
- "dflt": 0,
+ "zmid": {
+ "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
+ "dflt": null,
"editType": "calc",
- "max": 1,
- "min": 0,
+ "impliedEdits": {},
"valType": "number"
},
- "barmode": {
- "description": "Determines how bars at the same location coordinate are displayed on the graph. With *stack*, the bars are stacked on top of one another With *relative*, the bars are stacked on top of one another, with negative values below the axis, positive values above With *group*, the bars are plotted next to one another centered around the shared location. With *overlay*, the bars are plotted over one another, you might need to reduce *opacity* to see multiple bars.",
- "dflt": "group",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "stack",
- "group",
- "overlay",
- "relative"
- ]
+ "zmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "zauto": false
+ },
+ "valType": "number"
},
- "barnorm": {
- "description": "Sets the normalization for bar traces on the graph. With *fraction*, the value of each bar is divided by the sum of all values at that location coordinate. *percent* is the same but multiplied by 100 to show percentages.",
- "dflt": "",
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ },
+ "zsmooth": {
+ "description": "Picks a smoothing algorithm use to smooth `z` data.",
+ "dflt": false,
"editType": "calc",
"valType": "enumerated",
"values": [
- "",
- "fraction",
- "percent"
+ "fast",
+ "best",
+ false
]
+ },
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
+ "editType": "none",
+ "valType": "string"
}
},
+ "categories": [
+ "cartesian",
+ "svg",
+ "2dMap",
+ "showLegend"
+ ],
"meta": {
- "description": "The sample data from which statistics are computed is set in `x` for vertically spanning histograms and in `y` for horizontally spanning histograms. Binning options are set `xbins` and `ybins` respectively if no aggregation data is provided."
+ "description": "The data that describes the heatmap value-to-color mapping is set in `z`. Data in `z` can either be a {2D array} of values (ragged or not) or a 1D array of values. In the case where `z` is a {2D array}, say that `z` has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in `z` is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using `transpose`. Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) elements. If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where `z` is a 1D {array}, the x and y coordinates must be provided in `x` and `y` respectively to form data triplets."
},
- "type": "histogram"
+ "type": "heatmap"
},
- "histogram2d": {
+ "heatmapgl": {
"animatable": false,
"attributes": {
- "autobinx": {
- "description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.",
- "dflt": null,
- "editType": "calc",
- "valType": "boolean"
- },
- "autobiny": {
- "description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.",
- "dflt": null,
- "editType": "calc",
- "valType": "boolean"
- },
"autocolorscale": {
"description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
"dflt": false,
@@ -42974,12 +42351,6 @@
"impliedEdits": {},
"valType": "boolean"
},
- "bingroup": {
- "description": "Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of *1* on two histogram2d traces will make them their x-bins and y-bins match separately.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
"coloraxis": {
"description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
"dflt": null,
@@ -42991,19 +42362,19 @@
"_deprecated": {
"title": {
"description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"titlefont": {
"color": {
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
"description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
+ "editType": "calc",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
+ "editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -43011,7 +42382,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"none"
],
@@ -43025,18 +42396,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"size": {
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43046,7 +42417,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43058,7 +42429,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43072,7 +42443,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"normal",
"bold"
@@ -43085,7 +42456,7 @@
"titleside": {
"description": "Deprecated in favor of color bar's `title.side`.",
"dflt": "top",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"right",
@@ -43097,35 +42468,35 @@
"bgcolor": {
"description": "Sets the color of padded area.",
"dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
"dflt": 0,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
"dtick": {
"description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
+ "editType": "calc",
"impliedEdits": {
"tickmode": "linear"
},
"valType": "any"
},
- "editType": "colorbars",
+ "editType": "calc",
"exponentformat": {
"description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
"dflt": "B",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"none",
@@ -43139,20 +42510,20 @@
"labelalias": {
"description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
"dflt": false,
- "editType": "colorbars",
+ "editType": "calc",
"valType": "any"
},
"len": {
"description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
"lenmode": {
"description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
"dflt": "fraction",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"fraction",
@@ -43162,21 +42533,21 @@
"minexponent": {
"description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
"dflt": 3,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
"nticks": {
"description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
"dflt": 0,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "integer"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
"dflt": "v",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"h",
@@ -43186,13 +42557,13 @@
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
@@ -43200,13 +42571,13 @@
"separatethousands": {
"description": "If \"true\", even 4-digit integers are separated",
"dflt": false,
- "editType": "colorbars",
+ "editType": "calc",
"valType": "boolean"
},
"showexponent": {
"description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
"dflt": "all",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"all",
@@ -43218,13 +42589,13 @@
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "colorbars",
+ "editType": "calc",
"valType": "boolean"
},
"showtickprefix": {
"description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
"dflt": "all",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"all",
@@ -43236,7 +42607,7 @@
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
"dflt": "all",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"all",
@@ -43248,14 +42619,14 @@
"thickness": {
"description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
"dflt": 30,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
"thicknessmode": {
"description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
"dflt": "pixels",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"fraction",
@@ -43264,7 +42635,7 @@
},
"tick0": {
"description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
+ "editType": "calc",
"impliedEdits": {
"tickmode": "linear"
},
@@ -43273,25 +42644,25 @@
"tickangle": {
"description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
"dflt": "auto",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "angle"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
"tickfont": {
"color": {
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
"description": "Sets the color bar's tick label font",
- "editType": "colorbars",
+ "editType": "calc",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
+ "editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -43299,7 +42670,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"none"
],
@@ -43314,18 +42685,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"size": {
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43335,7 +42706,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43347,7 +42718,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43361,7 +42732,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"normal",
"bold"
@@ -43374,7 +42745,7 @@
"tickformat": {
"description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
"dflt": "",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"tickformatstops": {
@@ -43382,41 +42753,41 @@
"tickformatstop": {
"dtickrange": {
"description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
+ "editType": "calc",
"items": [
{
- "editType": "colorbars",
+ "editType": "calc",
"valType": "any"
},
{
- "editType": "colorbars",
+ "editType": "calc",
"valType": "any"
}
],
"valType": "info_array"
},
- "editType": "colorbars",
+ "editType": "calc",
"enabled": {
"description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
"dflt": true,
- "editType": "colorbars",
+ "editType": "calc",
"valType": "boolean"
},
"name": {
"description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"role": "object",
"templateitemname": {
"description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"value": {
"description": "string - dtickformat for described zoom level, the same as *tickformat*",
"dflt": "",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
}
}
@@ -43425,7 +42796,7 @@
},
"ticklabeloverflow": {
"description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"allow",
@@ -43436,7 +42807,7 @@
"ticklabelposition": {
"description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
"dflt": "outside",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"outside",
@@ -43454,20 +42825,20 @@
"ticklabelstep": {
"description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "integer"
},
"ticklen": {
"description": "Sets the tick length (in px).",
"dflt": 5,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
"tickmode": {
"description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
+ "editType": "calc",
"impliedEdits": {},
"valType": "enumerated",
"values": [
@@ -43479,13 +42850,13 @@
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"ticks": {
"description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
"dflt": "",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"outside",
@@ -43496,12 +42867,12 @@
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"ticktext": {
"description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "data_array"
},
"ticktextsrc": {
@@ -43511,7 +42882,7 @@
},
"tickvals": {
"description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "data_array"
},
"tickvalssrc": {
@@ -43522,22 +42893,22 @@
"tickwidth": {
"description": "Sets the tick width (in px).",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
"title": {
- "editType": "colorbars",
+ "editType": "calc",
"font": {
"color": {
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
"description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
+ "editType": "calc",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
+ "editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -43545,7 +42916,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"none"
],
@@ -43560,18 +42931,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"size": {
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43581,7 +42952,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43593,7 +42964,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -43607,7 +42978,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"normal",
"bold"
@@ -43620,7 +42991,7 @@
"role": "object",
"side": {
"description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"right",
@@ -43630,18 +43001,18 @@
},
"text": {
"description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
}
},
"x": {
"description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "number"
},
"xanchor": {
"description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"left",
@@ -43652,14 +43023,14 @@
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
"dflt": 10,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
"xref": {
"description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
"dflt": "paper",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"container",
@@ -43668,12 +43039,12 @@
},
"y": {
"description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "number"
},
"yanchor": {
"description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"top",
@@ -43684,14 +43055,14 @@
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
"dflt": 10,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number"
},
"yref": {
"description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
"dflt": "paper",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"container",
@@ -43718,31 +43089,23 @@
"editType": "none",
"valType": "string"
},
- "histfunc": {
- "description": "Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.",
- "dflt": "count",
+ "dx": {
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "count",
- "sum",
- "avg",
- "min",
- "max"
- ]
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "number"
},
- "histnorm": {
- "description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
- "dflt": "",
+ "dy": {
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "",
- "percent",
- "probability",
- "density",
- "probability density"
- ]
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "number"
},
"hoverinfo": {
"arrayOk": true,
@@ -43967,18 +43330,6 @@
},
"role": "object"
},
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
"ids": {
"description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
"editType": "calc",
@@ -43995,12 +43346,6 @@
"editType": "style",
"valType": "subplotid"
},
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
"legendgrouptitle": {
"editType": "style",
"font": {
@@ -44112,20 +43457,6 @@
"min": 0,
"valType": "number"
},
- "marker": {
- "color": {
- "description": "Sets the aggregation data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "role": "object"
- },
"meta": {
"arrayOk": true,
"description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
@@ -44142,20 +43473,6 @@
"editType": "style",
"valType": "string"
},
- "nbinsx": {
- "description": "Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "nbinsy": {
- "description": "Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
"opacity": {
"description": "Sets the opacity of the trace.",
"dflt": 1,
@@ -44167,13 +43484,7 @@
"reversescale": {
"description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
"dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "style",
+ "editType": "calc",
"valType": "boolean"
},
"showscale": {
@@ -44201,101 +43512,14 @@
"valType": "string"
}
},
- "textfont": {
- "color": {
- "dflt": "auto",
- "editType": "style",
- "valType": "color"
- },
- "description": "Sets the text font.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "dflt": "auto",
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "text": {
+ "description": "Sets the text elements associated with each z value.",
+ "editType": "calc",
+ "valType": "data_array"
},
- "texttemplate": {
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z`",
- "dflt": "",
- "editType": "plot",
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
"valType": "string"
},
"transforms": {
@@ -44308,7 +43532,13 @@
},
"role": "object"
},
- "type": "histogram2d",
+ "transpose": {
+ "description": "Transposes the z data.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "type": "heatmapgl",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -44331,163 +43561,81 @@
]
},
"x": {
- "description": "Sets the sample data to be binned on the x axis.",
- "editType": "calc+clearAxisTypes",
+ "description": "Sets the x coordinates.",
+ "editType": "calc",
+ "impliedEdits": {
+ "xtype": "array"
+ },
"valType": "data_array"
},
+ "x0": {
+ "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
+ "dflt": 0,
+ "editType": "calc",
+ "impliedEdits": {
+ "xtype": "scaled"
+ },
+ "valType": "any"
+ },
"xaxis": {
"description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
"dflt": "x",
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "xbingroup": {
- "description": "Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`",
- "dflt": "",
- "editType": "calc",
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
"valType": "string"
},
- "xbins": {
- "editType": "calc",
- "end": {
- "description": "Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.",
- "editType": "calc",
- "valType": "any"
- },
- "role": "object",
- "size": {
- "description": "Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). ",
- "editType": "calc",
- "valType": "any"
- },
- "start": {
- "description": "Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. ",
- "editType": "calc",
- "valType": "any"
- }
- },
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
+ "xtype": {
+ "description": "If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).",
"editType": "calc",
"valType": "enumerated",
"values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
+ "array",
+ "scaled"
]
},
- "xgap": {
- "description": "Sets the horizontal gap (in pixels) between bricks.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
"y": {
- "description": "Sets the sample data to be binned on the y axis.",
- "editType": "calc+clearAxisTypes",
+ "description": "Sets the y coordinates.",
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "array"
+ },
"valType": "data_array"
},
+ "y0": {
+ "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
+ "dflt": 0,
+ "editType": "calc",
+ "impliedEdits": {
+ "ytype": "scaled"
+ },
+ "valType": "any"
+ },
"yaxis": {
"description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
"dflt": "y",
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "ybingroup": {
- "description": "Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`",
- "dflt": "",
- "editType": "calc",
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
"valType": "string"
},
- "ybins": {
- "editType": "calc",
- "end": {
- "description": "Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.",
- "editType": "calc",
- "valType": "any"
- },
- "role": "object",
- "size": {
- "description": "Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). ",
- "editType": "calc",
- "valType": "any"
- },
- "start": {
- "description": "Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. ",
- "editType": "calc",
- "valType": "any"
- }
- },
- "ycalendar": {
- "description": "Sets the calendar system to use with `y` date data.",
- "dflt": "gregorian",
+ "ytype": {
+ "description": "If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)",
"editType": "calc",
"valType": "enumerated",
"values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
+ "array",
+ "scaled"
]
},
- "ygap": {
- "description": "Sets the vertical gap (in pixels) between bricks.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
"z": {
- "description": "Sets the aggregation data.",
+ "description": "Sets the z data.",
"editType": "calc",
"valType": "data_array"
},
@@ -44498,16 +43646,10 @@
"impliedEdits": {},
"valType": "boolean"
},
- "zhoverformat": {
- "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
"zmax": {
"description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
"dflt": null,
- "editType": "plot",
+ "editType": "calc",
"impliedEdits": {
"zauto": false
},
@@ -44523,7 +43665,7 @@
"zmin": {
"description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
"dflt": null,
- "editType": "plot",
+ "editType": "calc",
"impliedEdits": {
"zauto": false
},
@@ -44531,12 +43673,11 @@
},
"zsmooth": {
"description": "Picks a smoothing algorithm use to smooth `z` data.",
- "dflt": false,
+ "dflt": "fast",
"editType": "calc",
"valType": "enumerated",
"values": [
"fast",
- "best",
false
]
},
@@ -44547,21 +43688,35 @@
}
},
"categories": [
- "cartesian",
- "svg",
- "2dMap",
- "histogram",
- "showLegend"
+ "gl",
+ "gl2d",
+ "2dMap"
],
"meta": {
- "description": "The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a heatmap.",
- "hrName": "histogram_2d"
+ "description": "*heatmapgl* trace is deprecated! Please consider switching to the *heatmap* or *image* trace types. Alternatively you could contribute/sponsor rewriting this trace type based on cartesian features and using regl framework. WebGL version of the heatmap trace type."
},
- "type": "histogram2d"
+ "type": "heatmapgl"
},
- "histogram2dcontour": {
+ "histogram": {
"animatable": false,
"attributes": {
+ "_deprecated": {
+ "bardir": {
+ "description": "Renamed to `orientation`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "v",
+ "h"
+ ]
+ }
+ },
+ "alignmentgroup": {
+ "description": "Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
"autobinx": {
"description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.",
"dflt": null,
@@ -44574,346 +43729,389 @@
"editType": "calc",
"valType": "boolean"
},
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
+ "bingroup": {
+ "description": "Set a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same *orientation* under `barmode` *stack*, *relative* and *group* are forced into the same bingroup, Using `bingroup`, traces under `barmode` *overlay* and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same `bingroup`",
+ "dflt": "",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "string"
},
- "autocontour": {
- "description": "Determines whether or not the contour level attributes are picked by an algorithm. If *true*, the number of contour levels can be set in `ncontours`. If *false*, set the contour level attributes in `contours`.",
+ "cliponaxis": {
+ "description": "Determines whether the text nodes are clipped about the subplot axes. To show the text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.",
"dflt": true,
- "editType": "calc",
- "impliedEdits": {},
+ "editType": "plot",
"valType": "boolean"
},
- "bingroup": {
- "description": "Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of *1* on two histogram2d traces will make them their x-bins and y-bins match separately.",
- "dflt": "",
+ "constraintext": {
+ "description": "Constrain the size of text inside or outside a bar to be no larger than the bar itself.",
+ "dflt": "both",
"editType": "calc",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "outside",
+ "both",
+ "none"
+ ]
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
+ "cumulative": {
+ "currentbin": {
+ "description": "Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. *include* is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. *exclude* makes the opposite half-bin bias, and *half* removes it.",
+ "dflt": "include",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "include",
+ "exclude",
+ "half"
+ ]
+ },
+ "direction": {
+ "description": "Only applies if cumulative is enabled. If *increasing* (default) we sum all prior bins, so the result increases from left to right. If *decreasing* we sum later bins so the result decreases from left to right.",
+ "dflt": "increasing",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "increasing",
+ "decreasing"
+ ]
+ },
"editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "enabled": {
+ "description": "If true, display the cumulative distribution by summing the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the *density* `histnorm` settings behave the same as their equivalents without *density*: ** and *density* both rise to the number of data points, and *probability* and *probability density* both rise to the number of sample points.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "role": "object"
},
- "colorbar": {
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "error_x": {
"_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "style",
+ "valType": "number"
}
},
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
},
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
},
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
},
- "editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "style",
+ "valType": "color"
},
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "copy_ystyle": {
+ "editType": "plot",
+ "valType": "boolean"
},
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
+ "editType": "calc",
+ "role": "object",
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
+ "editType": "calc",
+ "valType": "boolean"
},
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "style",
"min": 0,
"valType": "number"
},
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "traceref": {
"dflt": 0,
- "editType": "colorbars",
+ "editType": "style",
"min": 0,
"valType": "integer"
},
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "h",
- "v"
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
]
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
+ "editType": "calc",
"min": 0,
"valType": "number"
},
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
"valType": "boolean"
},
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "error_y": {
+ "_deprecated": {
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "style",
+ "valType": "number"
+ }
},
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object",
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
+ "editType": "calc",
"valType": "boolean"
},
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
+ "traceref": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
]
},
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
+ "editType": "calc",
"min": 0,
"valType": "number"
},
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "histfunc": {
+ "description": "Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.",
+ "dflt": "count",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "count",
+ "sum",
+ "avg",
+ "min",
+ "max"
+ ]
+ },
+ "histnorm": {
+ "description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "",
+ "percent",
+ "probability",
+ "density",
+ "probability density"
+ ]
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "left",
+ "right",
+ "auto"
]
},
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
"valType": "color"
},
- "tickfont": {
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
"color": {
- "editType": "colorbars",
+ "arrayOk": true,
+ "editType": "none",
"valType": "color"
},
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
+ "editType": "none",
"noBlank": true,
"strict": true,
"valType": "string"
},
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
"lineposition": {
+ "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "none",
"extras": [
"none"
],
@@ -44924,32 +44122,56 @@
],
"valType": "flaglist"
},
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
"shadow": {
+ "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
"valType": "string"
},
"size": {
- "editType": "colorbars",
+ "arrayOk": true,
+ "editType": "none",
"min": 1,
"valType": "number"
},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
"textcase": {
+ "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -44958,10 +44180,16 @@
"lower"
]
},
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -44972,10 +44200,16 @@
"unicase"
]
},
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -44983,382 +44217,186 @@
"max": 1000,
"min": 1,
"valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
"valType": "string"
},
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
- },
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
- "impliedEdits": {},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ]
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- ""
- ]
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `binNumber` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Same as `text`.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "insidetextanchor": {
+ "description": "Determines if texts are kept at center or start/end points in `textposition` *inside* mode.",
+ "dflt": "end",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "end",
+ "middle",
+ "start"
+ ]
+ },
+ "insidetextfont": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
+ "description": "Sets the font used for `text` lying inside the bar.",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
},
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
"valType": "string"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
- "valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
+ "size": {
+ "editType": "plot",
+ "min": 1,
"valType": "number"
},
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "left",
- "center",
- "right"
+ "normal",
+ "italic"
]
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "top",
- "middle",
- "bottom"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
- "colorscale": {
- "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
},
- "contours": {
- "coloring": {
- "description": "Determines the coloring method showing the contour values. If *fill*, coloring is done evenly between each contour level If *heatmap*, a heatmap gradient coloring is applied between each contour level. If *lines*, coloring is done on the contour lines. If *none*, no coloring is applied on this trace.",
- "dflt": "fill",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fill",
- "heatmap",
- "lines",
- "none"
- ]
- },
- "editType": "calc",
- "end": {
- "description": "Sets the end contour level value. Must be more than `contours.start`",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "^autocontour": false
- },
- "valType": "number"
- },
- "impliedEdits": {
- "autocontour": false,
- "role": "object"
- },
- "labelfont": {
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
"color": {
"editType": "style",
"valType": "color"
},
- "description": "Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.",
- "editType": "plot",
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
+ "editType": "style",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -45366,7 +44404,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "plot",
+ "editType": "style",
"extras": [
"none"
],
@@ -45381,18 +44419,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "plot",
+ "editType": "style",
"valType": "string"
},
"size": {
- "editType": "plot",
+ "editType": "style",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -45402,7 +44440,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -45414,7 +44452,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -45428,7 +44466,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"extras": [
"normal",
"bold"
@@ -45438,537 +44476,1020 @@
"valType": "integer"
}
},
- "labelformat": {
- "description": "Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
"dflt": "",
- "editType": "plot",
+ "editType": "style",
"valType": "string"
- },
- "operation": {
- "description": "Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.",
- "dflt": "=",
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "marker": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "=",
- "<",
- ">=",
- ">",
- "<=",
- "[]",
- "()",
- "[)",
- "(]",
- "][",
- ")(",
- "](",
- ")["
- ]
- },
- "role": "object",
- "showlabels": {
- "description": "Determines whether to label the contour lines with their values.",
- "dflt": false,
- "editType": "plot",
+ "impliedEdits": {},
"valType": "boolean"
},
- "showlines": {
- "description": "Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to *fill*.",
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
"dflt": true,
- "editType": "plot",
+ "editType": "calc",
+ "impliedEdits": {},
"valType": "boolean"
},
- "size": {
- "description": "Sets the step between each contour level. Must be positive.",
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
"dflt": null,
"editType": "plot",
"impliedEdits": {
- "^autocontour": false
+ "cauto": false
},
- "min": 0,
"valType": "number"
},
- "start": {
- "description": "Sets the starting contour level value. Must be less than `contours.end`",
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
"dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "^autocontour": false
- },
- "valType": "number"
- },
- "type": {
- "description": "If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.",
- "dflt": "levels",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "levels",
- "constraint"
- ]
- },
- "value": {
- "description": "Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) *value* is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) *value* is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.",
- "dflt": 0,
"editType": "calc",
- "valType": "any"
- }
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "histfunc": {
- "description": "Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.",
- "dflt": "count",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "count",
- "sum",
- "avg",
- "min",
- "max"
- ]
- },
- "histnorm": {
- "description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
- "dflt": "",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "",
- "percent",
- "probability",
- "density",
- "probability density"
- ]
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
+ "impliedEdits": {},
+ "valType": "number"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
},
- "bordercolor": {
+ "color": {
"arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
+ "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
+ "editType": "style",
"valType": "color"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
},
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
},
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
},
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
},
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "h",
+ "v"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
},
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "style",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
},
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "style",
- "valType": "string"
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
},
- "size": {
- "editType": "style",
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
"min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "auto",
+ "linear",
+ "array"
]
},
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "style",
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "outside",
+ "inside",
+ ""
]
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "left",
+ "center",
+ "right"
]
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "line": {
- "color": {
- "description": "Sets the color of the contour level. Has no effect if `contours.coloring` is set to *lines*.",
- "editType": "style+colorbars",
- "valType": "color"
- },
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
- "dflt": "solid",
- "editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ]
- },
- "editType": "plot",
- "role": "object",
- "smoothing": {
- "description": "Sets the amount of smoothing for the contour lines, where *0* corresponds to no smoothing.",
- "dflt": 1,
- "editType": "plot",
- "max": 1.3,
- "min": 0,
- "valType": "number"
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
},
- "width": {
- "description": "Sets the contour line width in (in px)",
- "dflt": 0.5,
- "editType": "style+colorbars",
- "min": 0,
- "valType": "number"
- }
- },
- "marker": {
- "color": {
- "description": "Sets the aggregation data.",
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
- "valType": "data_array"
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
},
"colorsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
"valType": "string"
},
+ "cornerradius": {
+ "description": "Sets the rounding of corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %). Defaults to `layout.barcornerradius`. In stack or relative barmode, the first trace to set cornerradius is used for the whole stack.",
+ "editType": "calc",
+ "valType": "any"
+ },
"editType": "calc",
- "role": "object"
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the opacity of the bars.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "opacitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "pattern": {
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the pattern within the marker.",
+ "editType": "style",
+ "fgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "fgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "fgopacity": {
+ "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "fillmode": {
+ "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
+ "dflt": "replace",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "replace",
+ "overlay"
+ ]
+ },
+ "role": "object",
+ "shape": {
+ "arrayOk": true,
+ "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "",
+ "/",
+ "\\",
+ "x",
+ "-",
+ "|",
+ "+",
+ "."
+ ]
+ },
+ "shapesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
+ "dflt": 8,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "solidity": {
+ "arrayOk": true,
+ "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
+ "dflt": 0.3,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "soliditysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ }
},
"meta": {
"arrayOk": true,
@@ -46000,12 +45521,11 @@
"min": 0,
"valType": "integer"
},
- "ncontours": {
- "description": "Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.",
- "dflt": 15,
+ "offsetgroup": {
+ "description": "Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.",
+ "dflt": "",
"editType": "calc",
- "min": 1,
- "valType": "integer"
+ "valType": "string"
},
"opacity": {
"description": "Sets the opacity of the trace.",
@@ -46015,11 +45535,137 @@
"min": 0,
"valType": "number"
},
- "reversescale": {
- "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
- "dflt": false,
+ "orientation": {
+ "description": "Sets the orientation of the bars. With *v* (*h*), the value of the each bar spans along the vertical (horizontal).",
+ "editType": "calc+clearAxisTypes",
+ "valType": "enumerated",
+ "values": [
+ "v",
+ "h"
+ ]
+ },
+ "outsidetextfont": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "Sets the font used for `text` lying outside the bar.",
"editType": "plot",
- "valType": "boolean"
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "selected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of selected points.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object"
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of selected points.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "role": "object"
+ }
+ },
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
+ "editType": "calc",
+ "valType": "any"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
@@ -46027,12 +45673,6 @@
"editType": "style",
"valType": "boolean"
},
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
"stream": {
"editType": "calc",
"maxpoints": {
@@ -46052,13 +45692,25 @@
"valType": "string"
}
},
+ "text": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textangle": {
+ "description": "Sets the angle of the tick labels with respect to the bar. For example, a `tickangle` of -90 draws the tick labels vertically. With *auto* the texts may automatically be rotated to fit with the maximum size in bars.",
+ "dflt": "auto",
+ "editType": "plot",
+ "valType": "angle"
+ },
"textfont": {
"color": {
- "dflt": "auto",
"editType": "style",
"valType": "color"
},
- "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. Sets the text font.",
+ "description": "Sets the text font.",
"editType": "plot",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
@@ -46089,7 +45741,6 @@
"valType": "string"
},
"size": {
- "dflt": "auto",
"editType": "plot",
"min": 1,
"valType": "number"
@@ -46143,8 +45794,26 @@
"valType": "integer"
}
},
+ "textposition": {
+ "arrayOk": false,
+ "description": "Specifies the location of the `text`. *inside* positions `text` inside, next to the bar end (rotated and scaled if needed). *outside* positions `text` outside, next to the bar end (scaled if needed), unless there is another bar stacked on this one, then the text gets pushed inside. *auto* tries to position `text` inside the bar, but if the bar is too small and no bar is stacked on this one the text is moved outside. If *none*, no text appears.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "outside",
+ "auto",
+ "none"
+ ]
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
"texttemplate": {
- "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.",
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label` and `value`.",
"dflt": "",
"editType": "plot",
"valType": "string"
@@ -46159,7 +45828,7 @@
},
"role": "object"
},
- "type": "histogram2dcontour",
+ "type": "histogram",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -46170,6 +45839,35 @@
"editType": "none",
"valType": "any"
},
+ "unselected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "opacity": {
+ "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object"
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "role": "object"
+ }
+ },
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
"dflt": true,
@@ -46192,12 +45890,6 @@
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "xbingroup": {
- "description": "Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
"xbins": {
"editType": "calc",
"end": {
@@ -46207,12 +45899,12 @@
},
"role": "object",
"size": {
- "description": "Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). ",
+ "description": "Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.",
"editType": "calc",
"valType": "any"
},
"start": {
- "description": "Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. ",
+ "description": "Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.",
"editType": "calc",
"valType": "any"
}
@@ -46263,12 +45955,6 @@
"editType": "calc+clearAxisTypes",
"valType": "subplotid"
},
- "ybingroup": {
- "description": "Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
"ybins": {
"editType": "calc",
"end": {
@@ -46278,12 +45964,12 @@
},
"role": "object",
"size": {
- "description": "Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). ",
+ "description": "Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). If multiple non-overlaying histograms share a subplot, the first explicit `size` is used and all others discarded. If no `size` is provided,the sample data from all traces is combined to determine `size` as described above.",
"editType": "calc",
"valType": "any"
},
"start": {
- "description": "Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. ",
+ "description": "Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. If multiple non-overlaying histograms share a subplot, the first explicit `start` is used exactly and all others are shifted down (if necessary) to differ from that one by an integer number of bins.",
"editType": "calc",
"valType": "any"
}
@@ -46323,609 +46009,413 @@
"editType": "none",
"valType": "string"
},
- "z": {
- "description": "Sets the aggregation data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "zauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
- "dflt": true,
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ }
+ },
+ "categories": [
+ "bar-like",
+ "cartesian",
+ "svg",
+ "bar",
+ "histogram",
+ "oriented",
+ "errorBarsOK",
+ "showLegend"
+ ],
+ "layoutAttributes": {
+ "barcornerradius": {
+ "description": "Sets the rounding of bar corners. May be an integer number of pixels, or a percentage of bar width (as a string ending in %).",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "zhoverformat": {
- "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
+ "valType": "any"
},
- "zmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
- "dflt": null,
+ "bargap": {
+ "description": "Sets the gap (in plot fraction) between bars of adjacent location coordinates.",
"editType": "calc",
- "impliedEdits": {
- "zauto": false
- },
+ "max": 1,
+ "min": 0,
"valType": "number"
},
- "zmid": {
- "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
- "dflt": null,
+ "bargroupgap": {
+ "description": "Sets the gap (in plot fraction) between bars of the same location coordinate.",
+ "dflt": 0,
"editType": "calc",
- "impliedEdits": {},
+ "max": 1,
+ "min": 0,
"valType": "number"
},
- "zmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
- "dflt": null,
+ "barmode": {
+ "description": "Determines how bars at the same location coordinate are displayed on the graph. With *stack*, the bars are stacked on top of one another With *relative*, the bars are stacked on top of one another, with negative values below the axis, positive values above With *group*, the bars are plotted next to one another centered around the shared location. With *overlay*, the bars are plotted over one another, you might need to reduce *opacity* to see multiple bars.",
+ "dflt": "group",
"editType": "calc",
- "impliedEdits": {
- "zauto": false
- },
- "valType": "number"
+ "valType": "enumerated",
+ "values": [
+ "stack",
+ "group",
+ "overlay",
+ "relative"
+ ]
},
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
+ "barnorm": {
+ "description": "Sets the normalization for bar traces on the graph. With *fraction*, the value of each bar is divided by the sum of all values at that location coordinate. *percent* is the same but multiplied by 100 to show percentages.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "",
+ "fraction",
+ "percent"
+ ]
}
},
- "categories": [
- "cartesian",
- "svg",
- "2dMap",
- "contour",
- "histogram",
- "showLegend"
- ],
"meta": {
- "description": "The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a contour plot.",
- "hrName": "histogram_2d_contour"
+ "description": "The sample data from which statistics are computed is set in `x` for vertically spanning histograms and in `y` for horizontally spanning histograms. Binning options are set `xbins` and `ybins` respectively if no aggregation data is provided."
},
- "type": "histogram2dcontour"
+ "type": "histogram"
},
- "icicle": {
- "animatable": true,
+ "histogram2d": {
+ "animatable": false,
"attributes": {
- "branchvalues": {
- "description": "Determines how the items in `values` are summed. When set to *total*, items in `values` are taken to be value of all its descendants. 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.",
- "dflt": "remainder",
+ "autobinx": {
+ "description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.",
+ "dflt": null,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "remainder",
- "total"
- ]
+ "valType": "boolean"
},
- "count": {
- "description": "Determines default for `values` when it is not provided, by inferring a 1 for each of the *leaves* and/or *branches*, otherwise 0.",
- "dflt": "leaves",
+ "autobiny": {
+ "description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.",
+ "dflt": null,
"editType": "calc",
- "flags": [
- "branches",
- "leaves"
- ],
- "valType": "flaglist"
+ "valType": "boolean"
},
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": false,
"editType": "calc",
- "valType": "data_array"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
+ "bingroup": {
+ "description": "Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of *1* on two histogram2d traces will make them their x-bins and y-bins match separately.",
+ "dflt": "",
+ "editType": "calc",
"valType": "string"
},
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this icicle trace .",
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
"dflt": 0,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
- "valType": "integer"
+ "valType": "number"
},
- "editType": "calc",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this icicle trace .",
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
"dflt": 0,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "integer"
},
- "x": {
- "description": "Sets the horizontal domain of this icicle trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "y": {
- "description": "Sets the vertical domain of this icicle trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- }
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "label+text+value+name",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "label",
- "text",
- "value",
- "name",
- "current path",
- "percent root",
- "percent entry",
- "percent parent"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "left",
- "right",
- "auto"
+ "h",
+ "v"
]
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
"valType": "color"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "anim": true,
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "insidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `textinfo` lying inside the sector.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "fraction",
+ "pixels"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "labels": {
- "description": "Sets the labels of each of the sectors.",
- "editType": "calc",
- "valType": "data_array"
- },
- "labelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
- "editType": "none",
- "valType": "string"
- },
- "leaf": {
- "editType": "plot",
- "opacity": {
- "description": "Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
},
- "role": "object"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
+ "tickfont": {
"color": {
- "editType": "style",
+ "editType": "colorbars",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -46933,7 +46423,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "style",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -46948,18 +46438,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "style",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "style",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -46969,7 +46459,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -46981,7 +46471,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -46995,7 +46485,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -47005,380 +46495,169 @@
"valType": "integer"
}
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
"dflt": "",
- "editType": "style",
+ "editType": "colorbars",
"valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "level": {
- "anim": true,
- "description": "Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an \"id\" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.",
- "editType": "plot",
- "valType": "any"
- },
- "marker": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if colors is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if colors is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, `marker.cmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if colors is set to a numerical array. Value should have the same units as colors. Has no effect when `marker.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, `marker.cmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
},
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
"editType": "colorbars",
- "valType": "color"
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
},
- "description": "Deprecated in favor of color bar's `title.font`.",
"editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
"editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "valType": "boolean"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
"editType": "colorbars",
"valType": "string"
},
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
"editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
+ "valType": "string"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
"editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "valType": "string"
}
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
}
},
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
"editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
- },
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "tickfont": {
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
+ },
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
"color": {
"editType": "colorbars",
"valType": "color"
},
- "description": "Sets the color bar's tick label font",
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
"editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
@@ -47462,360 +46741,202 @@
"valType": "integer"
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
- },
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
- "impliedEdits": {},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ]
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "right",
+ "top",
+ "bottom"
]
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
"editType": "colorbars",
"valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
- "valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "top",
- "middle",
- "bottom"
- ]
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
}
},
- "colors": {
- "description": "Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.",
- "editType": "calc",
- "valType": "data_array"
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
},
- "colorssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "histfunc": {
+ "description": "Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.",
+ "dflt": "count",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "count",
+ "sum",
+ "avg",
+ "min",
+ "max"
+ ]
+ },
+ "histnorm": {
+ "description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "",
+ "percent",
+ "probability",
+ "density",
+ "probability density"
+ ]
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
"editType": "none",
"valType": "string"
},
- "editType": "calc",
- "line": {
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
"color": {
"arrayOk": true,
- "description": "Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.",
- "dflt": null,
- "editType": "style",
+ "editType": "none",
"valType": "color"
},
"colorsrc": {
@@ -47823,93 +46944,58 @@
"editType": "none",
"valType": "string"
},
- "editType": "calc",
- "role": "object",
- "width": {
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
"arrayOk": true,
- "description": "Sets the width (in px) of the line enclosing each sector.",
- "dflt": 1,
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "none",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
- }
- },
- "pattern": {
- "bgcolor": {
- "arrayOk": true,
- "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
- "editType": "style",
- "valType": "color"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
"editType": "none",
"valType": "string"
},
- "description": "Sets the pattern within the marker.",
- "editType": "style",
- "fgcolor": {
+ "lineposition": {
"arrayOk": true,
- "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
- "editType": "style",
- "valType": "color"
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "fgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
"editType": "none",
"valType": "string"
},
- "fgopacity": {
- "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "fillmode": {
- "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
- "dflt": "replace",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "replace",
- "overlay"
- ]
- },
"role": "object",
- "shape": {
+ "shadow": {
"arrayOk": true,
- "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
- "dflt": "",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "",
- "/",
- "\\",
- "x",
- "-",
- "|",
- "+",
- "."
- ]
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
},
- "shapesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
"editType": "none",
"valType": "string"
},
"size": {
"arrayOk": true,
- "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
- "dflt": 8,
- "editType": "style",
- "min": 0,
+ "editType": "none",
+ "min": 1,
"valType": "number"
},
"sizesrc": {
@@ -47917,275 +47003,148 @@
"editType": "none",
"valType": "string"
},
- "solidity": {
+ "style": {
"arrayOk": true,
- "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
- "dflt": 0.3,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
"editType": "none",
"valType": "string"
- }
- },
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- }
- },
- "maxdepth": {
- "description": "Sets the number of rendered sectors from any given `level`. Set `maxdepth` to *-1* to render all the levels in the hierarchy.",
- "dflt": -1,
- "editType": "plot",
- "valType": "integer"
- },
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "outsidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
},
- "variant": {
+ "namelength": {
"arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
"editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
+ "min": -1,
"valType": "integer"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
"editType": "none",
"valType": "string"
- }
+ },
+ "role": "object"
},
- "parents": {
- "description": "Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be \"ids\" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique.",
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
"editType": "calc",
"valType": "data_array"
},
- "parentssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `parents`.",
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
"editType": "none",
"valType": "string"
},
- "pathbar": {
- "edgeshape": {
- "description": "Determines which shape is used for edges between `barpath` labels.",
- "dflt": ">",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- ">",
- "<",
- "|",
- "/",
- "\\"
- ]
- },
- "editType": "calc",
- "role": "object",
- "side": {
- "description": "Determines on which side of the the treemap the `pathbar` should be presented.",
- "dflt": "top",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "top",
- "bottom"
- ]
- },
- "textfont": {
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
"color": {
- "arrayOk": true,
- "editType": "plot",
+ "editType": "style",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used inside `pathbar`.",
- "editType": "plot",
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
+ "editType": "style",
"noBlank": true,
"strict": true,
"valType": "string"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
"lineposition": {
- "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "plot",
+ "editType": "style",
"extras": [
"none"
],
@@ -48196,56 +47155,32 @@
],
"valType": "flaglist"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
- "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
+ "editType": "style",
"valType": "string"
},
"size": {
- "arrayOk": true,
- "editType": "plot",
+ "editType": "style",
"min": 1,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"style": {
- "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
"textcase": {
- "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -48254,16 +47189,10 @@
"lower"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -48274,16 +47203,10 @@
"unicase"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"extras": [
"normal",
"bold"
@@ -48291,38 +47214,94 @@
"max": 1000,
"min": 1,
"valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
}
},
- "thickness": {
- "description": "Sets the thickness of `pathbar` (in px). If not specified the `pathbar.textfont.size` is used with 3 pixles extra padding on each side.",
- "editType": "plot",
- "min": 12,
- "valType": "number"
- },
- "visible": {
- "description": "Determines if the path bar is drawn i.e. outside the trace `domain` and with one pixel gap.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
}
},
- "root": {
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "marker": {
"color": {
- "description": "sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.",
- "dflt": "rgba(0,0,0,0)",
+ "description": "Sets the aggregation data.",
"editType": "calc",
- "valType": "color"
+ "valType": "data_array"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
"editType": "calc",
"role": "object"
},
- "sort": {
- "description": "Determines whether or not the sectors are reordered from largest to smallest.",
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "nbinsx": {
+ "description": "Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "nbinsy": {
+ "description": "Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": false,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
"dflt": true,
"editType": "calc",
"valType": "boolean"
@@ -48346,39 +47325,22 @@
"valType": "string"
}
},
- "text": {
- "description": "Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "editType": "plot",
- "valType": "data_array"
- },
"textfont": {
"color": {
- "arrayOk": true,
- "editType": "plot",
+ "dflt": "auto",
+ "editType": "style",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `textinfo`.",
+ "description": "Sets the text font.",
"editType": "plot",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
"lineposition": {
- "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
"editType": "plot",
@@ -48392,37 +47354,20 @@
],
"valType": "flaglist"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
- "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
"editType": "plot",
"valType": "string"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
- "arrayOk": true,
+ "dflt": "auto",
"editType": "plot",
"min": 1,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"style": {
- "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
"editType": "plot",
@@ -48432,13 +47377,7 @@
"italic"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
"textcase": {
- "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
"editType": "plot",
@@ -48450,13 +47389,7 @@
"lower"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
"editType": "plot",
@@ -48470,13 +47403,7 @@
"unicase"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
"editType": "plot",
@@ -48487,95 +47414,14 @@
"max": 1000,
"min": 1,
"valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
}
},
- "textinfo": {
- "description": "Determines which trace information appear on the graph.",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "label",
- "text",
- "value",
- "current path",
- "percent root",
- "percent entry",
- "percent parent"
- ],
- "valType": "flaglist"
- },
- "textposition": {
- "description": "Sets the positions of the `text` elements.",
- "dflt": "top left",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "top left",
- "top center",
- "top right",
- "middle left",
- "middle center",
- "middle right",
- "bottom left",
- "bottom center",
- "bottom right"
- ]
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`.",
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z`",
"dflt": "",
"editType": "plot",
"valType": "string"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "tiling": {
- "editType": "calc",
- "flip": {
- "description": "Determines if the positions obtained from solver are flipped on each axis.",
- "dflt": "",
- "editType": "plot",
- "flags": [
- "x",
- "y"
- ],
- "valType": "flaglist"
- },
- "orientation": {
- "description": "When set in conjunction with `tiling.flip`, determines on which side the root nodes are drawn in the chart. If `tiling.orientation` is *v* and `tiling.flip` is **, the root nodes appear at the top. If `tiling.orientation` is *v* and `tiling.flip` is *y*, the root nodes appear at the bottom. If `tiling.orientation` is *h* and `tiling.flip` is **, the root nodes appear at the left. If `tiling.orientation` is *h* and `tiling.flip` is *x*, the root nodes appear at the right.",
- "dflt": "h",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "v",
- "h"
- ]
- },
- "pad": {
- "description": "Sets the inner padding (in px).",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "role": "object"
- },
"transforms": {
"items": {
"transform": {
@@ -48586,9 +47432,8 @@
},
"role": "object"
},
- "type": "icicle",
+ "type": "histogram2d",
"uid": {
- "anim": true,
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string"
@@ -48598,16 +47443,6 @@
"editType": "none",
"valType": "any"
},
- "values": {
- "description": "Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed.",
- "editType": "calc",
- "valType": "data_array"
- },
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
"dflt": true,
@@ -48618,338 +47453,583 @@
false,
"legendonly"
]
- }
- },
- "categories": [],
- "layoutAttributes": {
- "extendiciclecolors": {
- "description": "If `true`, the icicle slice colors (whether given by `iciclecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.",
- "dflt": true,
+ },
+ "x": {
+ "description": "Sets the sample data to be binned on the x axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "xbingroup": {
+ "description": "Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`",
+ "dflt": "",
"editType": "calc",
- "valType": "boolean"
+ "valType": "string"
},
- "iciclecolorway": {
- "description": "Sets the default icicle slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendiciclecolors`.",
+ "xbins": {
"editType": "calc",
- "valType": "colorlist"
- }
- },
- "meta": {
- "description": "Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The icicle sectors are determined by the entries in *labels* or *ids* and in *parents*."
- },
- "type": "icicle"
- },
- "image": {
- "animatable": false,
- "attributes": {
- "colormodel": {
- "description": "Color model used to map the numerical color components described in `z` into colors. If `source` is specified, this attribute will be set to `rgba256` otherwise it defaults to `rgb`.",
+ "end": {
+ "description": "Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). ",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "start": {
+ "description": "Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. ",
+ "editType": "calc",
+ "valType": "any"
+ }
+ },
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
"editType": "calc",
"valType": "enumerated",
"values": [
- "rgb",
- "rgba",
- "rgba256",
- "hsl",
- "hsla"
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
]
},
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
+ "xgap": {
+ "description": "Sets the horizontal gap (in pixels) between bricks.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
"editType": "none",
"valType": "string"
},
- "dx": {
- "description": "Set the pixel's horizontal size.",
- "dflt": 1,
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "y": {
+ "description": "Sets the sample data to be binned on the y axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "ybingroup": {
+ "description": "Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`",
+ "dflt": "",
"editType": "calc",
- "valType": "number"
+ "valType": "string"
},
- "dy": {
- "description": "Set the pixel's vertical size",
- "dflt": 1,
+ "ybins": {
+ "editType": "calc",
+ "end": {
+ "description": "Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). ",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "start": {
+ "description": "Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. ",
+ "editType": "calc",
+ "valType": "any"
+ }
+ },
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
"editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "ygap": {
+ "description": "Sets the vertical gap (in pixels) between bricks.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
"valType": "number"
},
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "x+y+z+text+name",
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
"editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "color",
- "name",
- "text"
- ],
- "valType": "flaglist"
+ "valType": "string"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
"editType": "none",
"valType": "string"
},
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
+ "z": {
+ "description": "Sets the aggregation data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "zauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "zmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "zauto": false
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "valType": "number"
+ },
+ "zmid": {
+ "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "zmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "zauto": false
},
+ "valType": "number"
+ },
+ "zsmooth": {
+ "description": "Picks a smoothing algorithm use to smooth `z` data.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fast",
+ "best",
+ false
+ ]
+ },
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
"editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
+ "valType": "string"
+ }
+ },
+ "categories": [
+ "cartesian",
+ "svg",
+ "2dMap",
+ "histogram",
+ "showLegend"
+ ],
+ "meta": {
+ "description": "The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a heatmap.",
+ "hrName": "histogram_2d"
+ },
+ "type": "histogram2d"
+ },
+ "histogram2dcontour": {
+ "animatable": false,
+ "attributes": {
+ "autobinx": {
+ "description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobinx` is not needed. However, we accept `autobinx: true` or `false` and will update `xbins` accordingly before deleting `autobinx` from the trace.",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "autobiny": {
+ "description": "Obsolete: since v1.42 each bin attribute is auto-determined separately and `autobiny` is not needed. However, we accept `autobiny: true` or `false` and will update `ybins` accordingly before deleting `autobiny` from the trace.",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "autocontour": {
+ "description": "Determines whether or not the contour level attributes are picked by an algorithm. If *true*, the number of contour levels can be set in `ncontours`. If *false*, set the contour level attributes in `contours`.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "bingroup": {
+ "description": "Set the `xbingroup` and `ybingroup` default prefix For example, setting a `bingroup` of *1* on two histogram2d traces will make them their x-bins and y-bins match separately.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
"valType": "string"
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "right",
+ "top",
+ "bottom"
]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
}
},
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
"valType": "integer"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
},
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `z`, `color` and `colormodel`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "description": "Same as `text`.",
- "editType": "plot",
- "valType": "data_array"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "tickfont": {
"color": {
- "editType": "style",
+ "editType": "colorbars",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -48957,7 +48037,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "style",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -48972,18 +48052,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "style",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "style",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -48993,7 +48073,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -49005,7 +48085,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -49019,7 +48099,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -49029,613 +48109,181 @@
"valType": "integer"
}
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
"dflt": "",
- "editType": "style",
+ "editType": "colorbars",
"valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "source": {
- "description": "Specifies the data URI of the image to be visualized. The URI consists of \"data:image/[][;base64],\"",
- "editType": "calc",
- "valType": "string"
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
},
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "text": {
- "description": "Sets the text elements associated with each z value.",
- "editType": "plot",
- "valType": "data_array"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "type": "image",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- },
- "x0": {
- "description": "Set the image's x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any"
- },
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "y0": {
- "description": "Set the image's y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any"
- },
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "z": {
- "description": "A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.",
- "editType": "calc",
- "valType": "data_array"
- },
- "zmax": {
- "description": "Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [255, 255, 255]. For the `rgba` colormodel, it is [255, 255, 255, 1]. For the `rgba256` colormodel, it is [255, 255, 255, 255]. For the `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1].",
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "valType": "number"
- },
- {
- "editType": "calc",
- "valType": "number"
- },
- {
- "editType": "calc",
- "valType": "number"
- },
- {
- "editType": "calc",
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "zmin": {
- "description": "Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For the `rgba256` colormodel, it is [0, 0, 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0].",
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "valType": "number"
- },
- {
- "editType": "calc",
- "valType": "number"
- },
- {
- "editType": "calc",
- "valType": "number"
- },
- {
- "editType": "calc",
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
- },
- "zsmooth": {
- "description": "Picks a smoothing algorithm used to smooth `z` data. This only applies for image traces that use the `source` attribute.",
- "dflt": false,
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "fast",
- false
- ]
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "categories": [
- "cartesian",
- "svg",
- "2dMap",
- "noSortingByValue"
- ],
- "meta": {
- "description": "Display an image, i.e. data on a 2D regular raster. By default, when an image is displayed in a subplot, its y axis will be reversed (ie. `autorange: 'reversed'`), constrained to the domain (ie. `constrain: 'domain'`) and it will have the same scale as its x axis (ie. `scaleanchor: 'x,`) in order for pixels to be rendered as squares."
- },
- "type": "image"
- },
- "indicator": {
- "animatable": true,
- "attributes": {
- "align": {
- "description": "Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "delta": {
- "decreasing": {
- "color": {
- "description": "Sets the color for increasing value.",
- "dflt": "#FF4136",
- "editType": "plot",
- "valType": "color"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
},
- "editType": "plot",
- "role": "object",
- "symbol": {
- "description": "Sets the symbol to display for increasing value",
- "dflt": "▼",
- "editType": "plot",
- "valType": "string"
- }
+ "role": "object"
},
- "editType": "calc",
- "font": {
- "color": {
- "editType": "plot",
- "valType": "color"
- },
- "description": "Set the font used to display the delta",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
},
- "increasing": {
- "color": {
- "description": "Sets the color for increasing value.",
- "dflt": "#3D9970",
- "editType": "plot",
- "valType": "color"
- },
- "editType": "plot",
- "role": "object",
- "symbol": {
- "description": "Sets the symbol to display for increasing value",
- "dflt": "▲",
- "editType": "plot",
- "valType": "string"
- }
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
},
- "position": {
- "description": "Sets the position of delta with respect to the number.",
- "dflt": "bottom",
- "editType": "plot",
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
"valType": "enumerated",
"values": [
- "top",
- "bottom",
- "left",
- "right"
+ "auto",
+ "linear",
+ "array"
]
},
- "prefix": {
- "description": "Sets a prefix appearing before the delta.",
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
"dflt": "",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "string"
},
- "reference": {
- "description": "Sets the reference value to compute the delta. By default, it is set to the current value.",
- "editType": "calc",
- "valType": "number"
- },
- "relative": {
- "description": "Show relative change",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
},
- "role": "object",
- "suffix": {
- "description": "Sets a suffix appearing next to the delta.",
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
"dflt": "",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "string"
},
- "valueformat": {
- "description": "Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
- "editType": "plot",
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
"valType": "string"
- }
- },
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this indicator trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
},
- "editType": "calc",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this indicator trace .",
- "dflt": 0,
- "editType": "calc",
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
"min": 0,
- "valType": "integer"
+ "valType": "number"
},
- "x": {
- "description": "Sets the horizontal domain of this indicator trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
},
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "y": {
- "description": "Sets the vertical domain of this indicator trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- }
- },
- "gauge": {
- "axis": {
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "plot",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "editType": "plot",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
- },
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "plot",
- "valType": "any"
- },
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "integer"
- },
- "range": {
- "description": "Sets the range of this axis.",
- "editType": "plot",
- "items": [
- {
- "editType": "plot",
- "valType": "number"
- },
- {
- "editType": "plot",
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "plot",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "plot",
- "valType": "angle"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "plot",
- "valType": "color"
- },
- "tickfont": {
- "color": {
- "editType": "plot",
- "valType": "color"
- },
- "description": "Sets the color bar's tick label font",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "plot",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -49650,18 +48298,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "plot",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -49671,7 +48319,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -49683,7 +48331,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -49697,7 +48345,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -49707,344 +48355,421 @@
"valType": "integer"
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "plot",
- "items": [
- {
- "editType": "plot",
- "valType": "any"
- },
- {
- "editType": "plot",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "plot",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "plot",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "plot",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "plot",
- "min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "plot",
- "impliedEdits": {},
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "auto",
- "linear",
- "array"
+ "right",
+ "top",
+ "bottom"
]
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "plot",
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
"valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "contours": {
+ "coloring": {
+ "description": "Determines the coloring method showing the contour values. If *fill*, coloring is done evenly between each contour level If *heatmap*, a heatmap gradient coloring is applied between each contour level. If *lines*, coloring is done on the contour lines. If *none*, no coloring is applied on this trace.",
+ "dflt": "fill",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fill",
+ "heatmap",
+ "lines",
+ "none"
+ ]
+ },
+ "editType": "calc",
+ "end": {
+ "description": "Sets the end contour level value. Must be more than `contours.start`",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "^autocontour": false
},
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "outside",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- ""
- ]
+ "valType": "number"
+ },
+ "impliedEdits": {
+ "autocontour": false,
+ "role": "object"
+ },
+ "labelfont": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
+ "description": "Sets the font used for labeling the contour levels. The default color comes from the lines, if shown. The default family and size come from `layout.font`.",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "plot",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
},
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
"editType": "plot",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
"editType": "plot",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
"valType": "string"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
+ "size": {
"editType": "plot",
- "min": 0,
+ "min": 1,
"valType": "number"
},
- "visible": {
- "description": "A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false",
- "dflt": true,
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "plot",
- "valType": "boolean"
- }
- },
- "bar": {
- "color": {
- "description": "Sets the background color of the arc.",
- "dflt": "green",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "plot",
- "valType": "color"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "description": "Set the appearance of the gauge's value",
- "editType": "calc",
- "line": {
- "color": {
- "description": "Sets the color of the line enclosing each sector.",
- "dflt": "#444",
- "editType": "plot",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object",
- "width": {
- "description": "Sets the width (in px) of the line enclosing each sector.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- }
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "role": "object",
- "thickness": {
- "description": "Sets the thickness of the bar as a fraction of the total thickness of the gauge.",
- "dflt": 1,
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
- "bgcolor": {
- "description": "Sets the gauge background color.",
- "editType": "plot",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the color of the border enclosing the gauge.",
- "dflt": "#444",
- "editType": "plot",
- "valType": "color"
- },
- "borderwidth": {
- "description": "Sets the width (in px) of the border enclosing the gauge.",
- "dflt": 1,
+ "labelformat": {
+ "description": "Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
+ "dflt": "",
"editType": "plot",
- "min": 0,
- "valType": "number"
+ "valType": "string"
},
- "description": "The gauge of the Indicator plot.",
- "editType": "plot",
- "role": "object",
- "shape": {
- "description": "Set the shape of the gauge",
- "dflt": "angular",
- "editType": "plot",
+ "operation": {
+ "description": "Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed for consistency with filter transforms.",
+ "dflt": "=",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "angular",
- "bullet"
+ "=",
+ "<",
+ ">=",
+ ">",
+ "<=",
+ "[]",
+ "()",
+ "[)",
+ "(]",
+ "][",
+ ")(",
+ "](",
+ ")["
]
},
- "steps": {
- "items": {
- "step": {
- "color": {
- "description": "Sets the background color of the arc.",
- "editType": "plot",
- "valType": "color"
- },
- "editType": "calc",
- "line": {
- "color": {
- "description": "Sets the color of the line enclosing each sector.",
- "dflt": "#444",
- "editType": "plot",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object",
- "width": {
- "description": "Sets the width (in px) of the line enclosing each sector.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- }
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "none",
- "valType": "string"
- },
- "range": {
- "description": "Sets the range of this axis.",
- "editType": "plot",
- "items": [
- {
- "editType": "plot",
- "valType": "number"
- },
- {
- "editType": "plot",
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
- "valType": "string"
- },
- "thickness": {
- "description": "Sets the thickness of the bar as a fraction of the total thickness of the gauge.",
- "dflt": 1,
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- }
- },
- "role": "object"
+ "role": "object",
+ "showlabels": {
+ "description": "Determines whether to label the contour lines with their values.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
},
- "threshold": {
+ "showlines": {
+ "description": "Determines whether or not the contour lines are drawn. Has an effect only if `contours.coloring` is set to *fill*.",
+ "dflt": true,
"editType": "plot",
- "line": {
- "color": {
- "description": "Sets the color of the threshold line.",
- "dflt": "#444",
- "editType": "plot",
- "valType": "color"
- },
- "editType": "plot",
- "role": "object",
- "width": {
- "description": "Sets the width (in px) of the threshold line.",
- "dflt": 1,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- }
+ "valType": "boolean"
+ },
+ "size": {
+ "description": "Sets the step between each contour level. Must be positive.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "^autocontour": false
},
- "role": "object",
- "thickness": {
- "description": "Sets the thickness of the threshold line as a fraction of the thickness of the gauge.",
- "dflt": 0.85,
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "min": 0,
+ "valType": "number"
+ },
+ "start": {
+ "description": "Sets the starting contour level value. Must be less than `contours.end`",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "^autocontour": false
},
- "value": {
- "description": "Sets a treshold value drawn as a line.",
- "dflt": false,
- "editType": "calc",
- "valType": "number"
- }
+ "valType": "number"
+ },
+ "type": {
+ "description": "If `levels`, the data is represented as a contour plot with multiple levels displayed. If `constraint`, the data is represented as constraints with the invalid region shaded as specified by the `operation` and `value` parameters.",
+ "dflt": "levels",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "levels",
+ "constraint"
+ ]
+ },
+ "value": {
+ "description": "Sets the value or values of the constraint boundary. When `operation` is set to one of the comparison values (=,<,>=,>,<=) *value* is expected to be a number. When `operation` is set to one of the interval values ([],(),[),(],][,)(,](,)[) *value* is expected to be an array of two numbers where the first is the lower bound and the second is the upper bound.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "any"
}
},
- "ids": {
- "anim": true,
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
"editType": "calc",
"valType": "data_array"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
"editType": "none",
"valType": "string"
},
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
+ "histfunc": {
+ "description": "Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.",
+ "dflt": "count",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "count",
+ "sum",
+ "avg",
+ "min",
+ "max"
+ ]
},
- "legendgrouptitle": {
- "editType": "style",
+ "histnorm": {
+ "description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "",
+ "percent",
+ "probability",
+ "density",
+ "probability density"
+ ]
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
"font": {
"color": {
- "editType": "style",
+ "arrayOk": true,
+ "editType": "none",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
+ "editType": "none",
"noBlank": true,
"strict": true,
"valType": "string"
},
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
"lineposition": {
+ "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "style",
+ "editType": "none",
"extras": [
"none"
],
@@ -50055,32 +48780,56 @@
],
"valType": "flaglist"
},
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
"shadow": {
+ "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "style",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
"valType": "string"
},
"size": {
- "editType": "style",
+ "arrayOk": true,
+ "editType": "none",
"min": 1,
"valType": "number"
},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
"textcase": {
+ "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -50089,10 +48838,16 @@
"lower"
]
},
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -50103,10 +48858,16 @@
"unicase"
]
},
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -50114,67 +48875,74 @@
"max": 1000,
"min": 1,
"valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
"valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
+ },
+ "role": "object"
},
- "meta": {
+ "hovertemplate": {
"arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variable `z` Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
"editType": "none",
"valType": "string"
},
- "mode": {
- "description": "Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis.",
- "dflt": "number",
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
"editType": "calc",
- "flags": [
- "number",
- "delta",
- "gauge"
- ],
- "valType": "flaglist"
+ "valType": "data_array"
},
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
"editType": "style",
"valType": "string"
},
- "number": {
- "editType": "plot",
+ "legendgrouptitle": {
+ "editType": "style",
"font": {
"color": {
- "editType": "plot",
+ "editType": "style",
"valType": "color"
},
- "description": "Set the font used to display main number",
- "editType": "plot",
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
+ "editType": "style",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -50182,7 +48950,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "plot",
+ "editType": "style",
"extras": [
"none"
],
@@ -50197,18 +48965,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "plot",
+ "editType": "style",
"valType": "string"
},
"size": {
- "editType": "plot",
+ "editType": "style",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -50218,7 +48986,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -50230,7 +48998,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -50244,7 +49012,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "style",
"extras": [
"normal",
"bold"
@@ -50254,33 +49022,148 @@
"valType": "integer"
}
},
- "prefix": {
- "description": "Sets a prefix appearing before the number.",
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
"dflt": "",
- "editType": "plot",
+ "editType": "style",
"valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the color of the contour level. Has no effect if `contours.coloring` is set to *lines*.",
+ "editType": "style+colorbars",
+ "valType": "color"
+ },
+ "dash": {
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
+ "dflt": "solid",
+ "editType": "style",
+ "valType": "string",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ]
},
+ "editType": "plot",
"role": "object",
- "suffix": {
- "description": "Sets a suffix appearing next to the number.",
- "dflt": "",
+ "smoothing": {
+ "description": "Sets the amount of smoothing for the contour lines, where *0* corresponds to no smoothing.",
+ "dflt": 1,
"editType": "plot",
- "valType": "string"
+ "max": 1.3,
+ "min": 0,
+ "valType": "number"
},
- "valueformat": {
- "description": "Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
+ "width": {
+ "description": "Sets the contour line width in (in px)",
+ "dflt": 0.5,
+ "editType": "style+colorbars",
+ "min": 0,
+ "valType": "number"
}
},
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
+ "marker": {
+ "color": {
+ "description": "Sets the aggregation data.",
"editType": "calc",
- "max": 10000,
+ "valType": "data_array"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "role": "object"
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "nbinsx": {
+ "description": "Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `xbins.size` is provided.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "nbinsy": {
+ "description": "Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if `ybins.size` is provided.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "ncontours": {
+ "description": "Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true* or if `contours.size` is missing.",
+ "dflt": 15,
+ "editType": "calc",
+ "min": 1,
+ "valType": "integer"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
"min": 0,
"valType": "number"
},
@@ -50293,114 +49176,103 @@
"valType": "string"
}
},
- "title": {
- "align": {
- "description": "Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it defaults to right.",
+ "textfont": {
+ "color": {
+ "dflt": "auto",
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. Sets the text font.",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "size": {
+ "dflt": "auto",
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "plot",
"valType": "enumerated",
"values": [
- "left",
- "center",
- "right"
+ "normal",
+ "italic"
]
},
- "editType": "plot",
- "font": {
- "color": {
- "editType": "plot",
- "valType": "color"
- },
- "description": "Set the font used to display the title",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "role": "object",
- "text": {
- "description": "Sets the title of this indicator.",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "plot",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
+ "texttemplate": {
+ "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
"transforms": {
"items": {
"transform": {
@@ -50411,9 +49283,8 @@
},
"role": "object"
},
- "type": "indicator",
+ "type": "histogram2dcontour",
"uid": {
- "anim": true,
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string"
@@ -50423,12 +49294,6 @@
"editType": "none",
"valType": "any"
},
- "value": {
- "anim": true,
- "description": "Sets the number to be displayed.",
- "editType": "calc",
- "valType": "number"
- },
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
"dflt": true,
@@ -50439,438 +49304,408 @@
false,
"legendonly"
]
- }
- },
- "categories": [
- "svg",
- "noOpacity",
- "noHover"
- ],
- "meta": {
- "description": "An indicator is used to visualize a single `value` along with some contextual information such as `steps` or a `threshold`, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a `reference`. Gauges can be either angular or bullet (aka linear) gauges."
- },
- "type": "indicator"
- },
- "isosurface": {
- "animatable": false,
- "attributes": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
+ },
+ "x": {
+ "description": "Sets the sample data to be binned on the x axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "xbingroup": {
+ "description": "Set a group of histogram traces which will have compatible x-bin settings. Using `xbingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same `xbingroup` value can be used to set (1D) histogram `bingroup`",
+ "dflt": "",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "string"
},
- "caps": {
+ "xbins": {
"editType": "calc",
+ "end": {
+ "description": "Sets the end value for the x axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.",
+ "editType": "calc",
+ "valType": "any"
+ },
"role": "object",
- "x": {
+ "size": {
+ "description": "Sets the size of each x axis bin. Default behavior: If `nbinsx` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsx` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). ",
"editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "show": {
- "description": "Sets the fill ratio of the `slices`. The default fill value of the x `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- }
+ "valType": "any"
},
- "y": {
+ "start": {
+ "description": "Sets the starting value for the x axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. ",
"editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "show": {
- "description": "Sets the fill ratio of the `slices`. The default fill value of the y `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- }
+ "valType": "any"
+ }
+ },
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "y": {
+ "description": "Sets the sample data to be binned on the y axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "ybingroup": {
+ "description": "Set a group of histogram traces which will have compatible y-bin settings. Using `ybingroup`, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same `ybingroup` value can be used to set (1D) histogram `bingroup`",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ybins": {
+ "editType": "calc",
+ "end": {
+ "description": "Sets the end value for the y axis bins. The last bin may not end exactly at this value, we increment the bin edge by `size` from `start` until we reach or exceed `end`. Defaults to the maximum data value. Like `start`, for dates use a date string, and for category data `end` is based on the category serial numbers.",
+ "editType": "calc",
+ "valType": "any"
},
- "z": {
+ "role": "object",
+ "size": {
+ "description": "Sets the size of each y axis bin. Default behavior: If `nbinsy` is 0 or omitted, we choose a nice round bin size such that the number of bins is about the same as the typical number of samples in each bin. If `nbinsy` is provided, we choose a nice round bin size giving no more than that many bins. For date data, use milliseconds or *M* for months, as in `axis.dtick`. For category data, the number of categories to bin together (always defaults to 1). ",
"editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "show": {
- "description": "Sets the fill ratio of the `slices`. The default fill value of the z `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- }
+ "valType": "any"
+ },
+ "start": {
+ "description": "Sets the starting value for the y axis bins. Defaults to the minimum data value, shifted down if necessary to make nice round values and to remove ambiguous bin edges. For example, if most of the data is integers we shift the bin edges 0.5 down, so a `size` of 5 would have a default `start` of -0.5, so it is clear that 0-4 are in the first bin, 5-9 in the second, but continuous data gets a start of 0 and bins [0,5), [5,10) etc. Dates behave similarly, and `start` should be a date string. For category data, `start` is based on the category serial numbers, and defaults to -0.5. ",
+ "editType": "calc",
+ "valType": "any"
}
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "z": {
+ "description": "Sets the aggregation data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "zauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.",
"dflt": true,
"editType": "calc",
"impliedEdits": {},
"valType": "boolean"
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.",
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "zmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.",
"dflt": null,
"editType": "calc",
"impliedEdits": {
- "cauto": false
+ "zauto": false
},
"valType": "number"
},
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`.",
+ "zmid": {
+ "description": "Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.",
"dflt": null,
"editType": "calc",
"impliedEdits": {},
"valType": "number"
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.",
+ "zmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.",
"dflt": null,
"editType": "calc",
"impliedEdits": {
- "cauto": false
+ "zauto": false
},
"valType": "number"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "categories": [
+ "cartesian",
+ "svg",
+ "2dMap",
+ "contour",
+ "histogram",
+ "showLegend"
+ ],
+ "meta": {
+ "description": "The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a contour plot.",
+ "hrName": "histogram_2d_contour"
+ },
+ "type": "histogram2dcontour"
+ },
+ "icicle": {
+ "animatable": true,
+ "attributes": {
+ "branchvalues": {
+ "description": "Determines how the items in `values` are summed. When set to *total*, items in `values` are taken to be value of all its descendants. 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.",
+ "dflt": "remainder",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "remainder",
+ "total"
+ ]
},
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "calc",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- }
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "calc",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "count": {
+ "description": "Determines default for `values` when it is not provided, by inferring a 1 for each of the *leaves* and/or *branches*, otherwise 0.",
+ "dflt": "leaves",
+ "editType": "calc",
+ "flags": [
+ "branches",
+ "leaves"
+ ],
+ "valType": "flaglist"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this icicle trace .",
"dflt": 0,
"editType": "calc",
"min": 0,
- "valType": "number"
- },
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "valType": "integer"
},
"editType": "calc",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
- },
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "calc",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this icicle trace .",
"dflt": 0,
"editType": "calc",
"min": 0,
"valType": "integer"
},
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
+ "x": {
+ "description": "Sets the horizontal domain of this icicle trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
+ "y": {
+ "description": "Sets the vertical domain of this icicle trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
"editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ }
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "label+text+value+name",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "value",
+ "name",
+ "current path",
+ "percent root",
+ "percent entry",
+ "percent parent"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "left",
+ "right",
+ "auto"
]
},
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
},
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
},
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "calc",
- "valType": "angle"
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "calc",
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
"valType": "color"
},
- "tickfont": {
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
"color": {
- "editType": "calc",
+ "arrayOk": true,
+ "editType": "none",
"valType": "color"
},
- "description": "Sets the color bar's tick label font",
- "editType": "calc",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
+ "editType": "none",
"noBlank": true,
"strict": true,
"valType": "string"
},
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
"lineposition": {
+ "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "calc",
+ "editType": "none",
"extras": [
"none"
],
@@ -50881,32 +49716,56 @@
],
"valType": "flaglist"
},
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
"shadow": {
+ "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "calc",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
"valType": "string"
},
"size": {
- "editType": "calc",
+ "arrayOk": true,
+ "editType": "none",
"min": 1,
"valType": "number"
},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
"textcase": {
+ "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -50915,10 +49774,16 @@
"lower"
]
},
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -50929,10 +49794,16 @@
"unicase"
]
},
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -50940,651 +49811,226 @@
"max": 1000,
"min": 1,
"valType": "integer"
- }
- },
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "valType": "any"
- },
- {
- "editType": "calc",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "calc",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "calc",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- }
- }
},
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
},
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "calc",
- "min": 1,
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
"valType": "integer"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "calc",
- "impliedEdits": {},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ]
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "calc",
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
"valType": "string"
},
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- ""
- ]
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry` and `percentParent`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "anim": true,
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "insidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "calc",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
"valType": "string"
},
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "calc",
- "valType": "data_array"
+ "description": "Sets the font used for `textinfo` lying inside the sector.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
"editType": "none",
"valType": "string"
},
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "calc",
- "valType": "data_array"
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
"editType": "none",
"valType": "string"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
},
- "title": {
- "editType": "calc",
- "font": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "calc",
- "valType": "string"
- }
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
},
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "calc",
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
"valType": "number"
},
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "calc",
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "normal",
+ "italic"
]
},
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "calc",
- "valType": "number"
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
},
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "calc",
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "top",
- "middle",
- "bottom"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
},
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "calc",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
- }
- },
- "colorscale": {
- "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "contour": {
- "color": {
- "description": "Sets the color of the contour lines.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
},
- "editType": "calc",
- "role": "object",
- "show": {
- "description": "Sets whether or not dynamic contours are shown on hover",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
},
- "width": {
- "description": "Sets the width of the contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
"min": 1,
- "valType": "number"
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "labels": {
+ "description": "Sets the labels of each of the sectors.",
"editType": "calc",
"valType": "data_array"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "labelssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
"editType": "none",
"valType": "string"
},
- "flatshading": {
- "description": "Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "calc",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "isomax": {
- "description": "Sets the maximum boundary for iso-surface plot.",
- "editType": "calc",
- "valType": "number"
- },
- "isomin": {
- "description": "Sets the minimum boundary for iso-surface plot.",
- "editType": "calc",
- "valType": "number"
+ "leaf": {
+ "editType": "plot",
+ "opacity": {
+ "description": "Sets the opacity of the leaves. With colorscale it is defaulted to 1; otherwise it is defaulted to 0.7",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object"
},
"legend": {
"description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
@@ -51592,12 +50038,6 @@
"editType": "style",
"valType": "subplotid"
},
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
"legendgrouptitle": {
"editType": "style",
"font": {
@@ -51709,1028 +50149,360 @@
"min": 0,
"valType": "number"
},
- "lighting": {
- "ambient": {
- "description": "Ambient light increases overall color visibility but can wash out the image.",
- "dflt": 0.8,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "diffuse": {
- "description": "Represents the extent that incident rays are reflected in a range of angles.",
- "dflt": 0.8,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "editType": "calc",
- "facenormalsepsilon": {
- "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 0,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "fresnel": {
- "description": "Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.",
- "dflt": 0.2,
- "editType": "calc",
- "max": 5,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "roughness": {
- "description": "Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.",
- "dflt": 0.5,
+ "level": {
+ "anim": true,
+ "description": "Sets the level from which this trace hierarchy is rendered. Set `level` to `''` to start from the root node in the hierarchy. Must be an \"id\" if `ids` is filled in, otherwise plotly attempts to find a matching item in `labels`.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "marker": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if colors is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
"editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "specular": {
- "description": "Represents the level that incident rays are reflected in a single direction, causing shine.",
- "dflt": 0.05,
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here colors) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if colors is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
+ "dflt": true,
"editType": "calc",
- "max": 2,
- "min": 0,
- "valType": "number"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "vertexnormalsepsilon": {
- "description": "Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 1e-12,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- },
- "lightposition": {
- "editType": "calc",
- "role": "object",
- "x": {
- "description": "Numeric vector, representing the X coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, `marker.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
+ },
"valType": "number"
},
- "y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 100000,
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if colors is set to a numerical array. Value should have the same units as colors. Has no effect when `marker.cauto` is `false`.",
+ "dflt": null,
"editType": "calc",
- "max": 100000,
- "min": -100000,
+ "impliedEdits": {},
"valType": "number"
},
- "z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number"
- }
- },
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "opacity": {
- "description": "Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "reversescale": {
- "description": "Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "scene": {
- "description": "Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.",
- "dflt": "scene",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "slices": {
- "editType": "calc",
- "role": "object",
- "x": {
- "editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "locations": {
- "description": "Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "locationssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
- "editType": "none",
- "valType": "string"
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if colors is set to a numerical array. Value should have the same units as colors and if set, `marker.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
},
- "role": "object",
- "show": {
- "description": "Determines whether or not slice planes about the x dimension are drawn.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- }
+ "valType": "number"
},
- "y": {
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
"editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "locations": {
- "description": "Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "locationssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "show": {
- "description": "Determines whether or not slice planes about the y dimension are drawn.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- }
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
},
- "z": {
- "editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "locations": {
- "description": "Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "locationssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "show": {
- "description": "Determines whether or not slice planes about the z dimension are drawn.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- }
- }
- },
- "spaceframe": {
- "editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the `spaceframe` elements. The default fill value is 0.15 meaning that only 15% of the area of every faces of tetras would be shaded. Applying a greater `fill` ratio would allow the creation of stronger elements or could be sued to have entirely closed areas (in case of using 1).",
- "dflt": 0.15,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "show": {
- "description": "Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- }
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "surface": {
- "count": {
- "description": "Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.",
- "dflt": 2,
- "editType": "calc",
- "min": 1,
- "valType": "integer"
- },
- "editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "pattern": {
- "description": "Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.",
- "dflt": "all",
- "editType": "calc",
- "extras": [
- "all",
- "odd",
- "even"
- ],
- "flags": [
- "A",
- "B",
- "C",
- "D",
- "E"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "show": {
- "description": "Hides/displays surfaces between minimum and maximum iso-values.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- }
- },
- "text": {
- "arrayOk": true,
- "description": "Sets the text elements associated with the vertices. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "type": "isosurface",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "value": {
- "description": "Sets the 4th dimension (value) of the vertices.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "valuehoverformat": {
- "description": "Sets the hover text formatting rulefor `value` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "valuesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `value`.",
- "editType": "none",
- "valType": "string"
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- },
- "x": {
- "description": "Sets the X coordinates of the vertices on X axis.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "y": {
- "description": "Sets the Y coordinates of the vertices on Y axis.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "z": {
- "description": "Sets the Z coordinates of the vertices on Z axis.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "zhoverformat": {
- "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `zaxis.hoverformat`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "categories": [
- "gl3d",
- "showLegend"
- ],
- "meta": {
- "description": "Draws isosurfaces between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the `value`, `x`, `y` and `z` of every vertex of a uniform or non-uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace."
- },
- "type": "isosurface"
- },
- "mesh3d": {
- "animatable": false,
- "attributes": {
- "alphahull": {
- "description": "Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If *-1*, Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If *>0*, the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If *0*, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull.",
- "dflt": -1,
- "editType": "calc",
- "valType": "number"
- },
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "color": {
- "description": "Sets the color of the whole mesh",
- "editType": "calc",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
"editType": "colorbars",
"valType": "string"
},
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
"editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "right",
+ "top",
+ "bottom"
]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
}
},
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "right",
- "top",
- "bottom"
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
]
- }
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
},
- "valType": "any"
- },
- "editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
- },
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
},
- "valType": "any"
- },
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "tickfont": {
- "color": {
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
"editType": "colorbars",
- "valType": "color"
+ "min": 0,
+ "valType": "number"
},
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
"editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
"editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "min": 0,
+ "valType": "number"
},
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
"editType": "colorbars",
- "valType": "string"
+ "min": 0,
+ "valType": "integer"
},
- "size": {
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
"editType": "colorbars",
- "min": 1,
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
"editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
+ "min": 0,
+ "valType": "number"
},
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
- },
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
- "impliedEdits": {},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ]
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- ""
- ]
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "title": {
- "editType": "colorbars",
- "font": {
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "tickfont": {
"color": {
"editType": "colorbars",
"valType": "color"
},
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "description": "Sets the color bar's tick label font",
"editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
@@ -52814,675 +50586,495 @@
"valType": "integer"
}
},
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
"editType": "colorbars",
"valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "top",
- "middle",
- "bottom"
- ]
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- }
- },
- "colorscale": {
- "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "contour": {
- "color": {
- "description": "Sets the color of the contour lines.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object",
- "show": {
- "description": "Sets whether or not dynamic contours are shown on hover",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "width": {
- "description": "Sets the width of the contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
- "valType": "number"
- }
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "delaunayaxis": {
- "description": "Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation.",
- "dflt": "z",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "x",
- "y",
- "z"
- ]
- },
- "facecolor": {
- "description": "Sets the color of each face Overrides *color* and *vertexcolor*.",
- "editType": "calc",
- "valType": "data_array"
- },
- "facecolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `facecolor`.",
- "editType": "none",
- "valType": "string"
- },
- "flatshading": {
- "description": "Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "calc",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
},
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
},
- "size": {
- "arrayOk": true,
- "editType": "none",
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
"min": 1,
- "valType": "number"
+ "valType": "integer"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "auto",
+ "linear",
+ "array"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "outside",
+ "inside",
+ ""
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
"editType": "none",
"valType": "string"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
"editType": "none",
"valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "i": {
- "description": "A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *first* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle.",
- "editType": "calc",
- "valType": "data_array"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "intensity": {
- "description": "Sets the intensity values for vertices or cells as defined by `intensitymode`. It can be used for plotting fields on meshes.",
- "editType": "calc",
- "valType": "data_array"
- },
- "intensitymode": {
- "description": "Determines the source of `intensity` values.",
- "dflt": "vertex",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "vertex",
- "cell"
- ]
- },
- "intensitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `intensity`.",
- "editType": "none",
- "valType": "string"
- },
- "isrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `i`.",
- "editType": "none",
- "valType": "string"
- },
- "j": {
- "description": "A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *second* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle.",
- "editType": "calc",
- "valType": "data_array"
- },
- "jsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `j`.",
- "editType": "none",
- "valType": "string"
- },
- "k": {
- "description": "A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *third* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle.",
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colors": {
+ "description": "Sets the color of each sector of this trace. If not specified, the default trace color set is used to pick the sector colors.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
+ "editType": "none",
+ "valType": "string"
+ },
"editType": "calc",
- "valType": "data_array"
- },
- "ksrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `k`.",
- "editType": "none",
- "valType": "string"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
+ "line": {
"color": {
+ "arrayOk": true,
+ "description": "Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.",
+ "dflt": null,
"editType": "style",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
"valType": "string"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the line enclosing each sector.",
+ "dflt": 1,
"editType": "style",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "min": 0,
+ "valType": "number"
},
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "pattern": {
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
"editType": "style",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
"valType": "string"
},
- "size": {
+ "description": "Sets the pattern within the marker.",
+ "editType": "style",
+ "fgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
"editType": "style",
- "min": 1,
+ "valType": "color"
+ },
+ "fgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "fgopacity": {
+ "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
"valType": "number"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
+ "fillmode": {
+ "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
+ "dflt": "replace",
"editType": "style",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "replace",
+ "overlay"
]
},
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
+ "role": "object",
+ "shape": {
+ "arrayOk": true,
+ "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
+ "dflt": "",
"editType": "style",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "",
+ "/",
+ "\\",
+ "x",
+ "-",
+ "|",
+ "+",
+ "."
]
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
+ "shapesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
+ "dflt": 8,
"editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
+ "min": 0,
+ "valType": "number"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "solidity": {
+ "arrayOk": true,
+ "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
+ "dflt": 0.3,
"editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "soliditysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "lighting": {
- "ambient": {
- "description": "Ambient light increases overall color visibility but can wash out the image.",
- "dflt": 0.8,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "diffuse": {
- "description": "Represents the extent that incident rays are reflected in a range of angles.",
- "dflt": 0.8,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "editType": "calc",
- "facenormalsepsilon": {
- "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 0.000001,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "fresnel": {
- "description": "Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.",
- "dflt": 0.2,
- "editType": "calc",
- "max": 5,
- "min": 0,
- "valType": "number"
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if colors is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
},
"role": "object",
- "roughness": {
- "description": "Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.",
- "dflt": 0.5,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "specular": {
- "description": "Represents the level that incident rays are reflected in a single direction, causing shine.",
- "dflt": 0.05,
- "editType": "calc",
- "max": 2,
- "min": 0,
- "valType": "number"
- },
- "vertexnormalsepsilon": {
- "description": "Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 1e-12,
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if colors is set to a numerical array.",
+ "dflt": false,
"editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "valType": "boolean"
}
},
- "lightposition": {
- "editType": "calc",
- "role": "object",
- "x": {
- "description": "Numeric vector, representing the X coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number"
- },
- "y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number"
- },
- "z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number"
- }
+ "maxdepth": {
+ "description": "Sets the number of rendered sectors from any given `level`. Set `maxdepth` to *-1* to render all the levels in the hierarchy.",
+ "dflt": -1,
+ "editType": "plot",
+ "valType": "integer"
},
"meta": {
"arrayOk": true,
@@ -53501,367 +51093,196 @@
"valType": "string"
},
"opacity": {
- "description": "Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.",
+ "description": "Sets the opacity of the trace.",
"dflt": 1,
- "editType": "calc",
+ "editType": "style",
"max": 1,
"min": 0,
"valType": "number"
},
- "reversescale": {
- "description": "Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "scene": {
- "description": "Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.",
- "dflt": "scene",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "style",
- "valType": "boolean"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
+ "outsidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
},
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used for `textinfo` lying outside the sector. This option refers to the root of the hierarchy presented on top left corner of a treemap graph. Please note that if a hierarchy has multiple root nodes, this option won't have any effect and `insidetextfont` would be used.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string"
- }
- },
- "text": {
- "arrayOk": true,
- "description": "Sets the text elements associated with the vertices. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "type": "mesh3d",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "vertexcolor": {
- "description": "Sets the color of each vertex Overrides *color*. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.",
- "editType": "calc",
- "valType": "data_array"
- },
- "vertexcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `vertexcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- },
- "x": {
- "description": "Sets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "y": {
- "description": "Sets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "ycalendar": {
- "description": "Sets the calendar system to use with `y` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "z": {
- "description": "Sets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "zcalendar": {
- "description": "Sets the calendar system to use with `z` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "zhoverformat": {
- "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `zaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "categories": [
- "gl3d",
- "showLegend"
- ],
- "meta": {
- "description": "Draws sets of triangles with coordinates given by three 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-shape algorithm or (4) the Convex-hull algorithm"
- },
- "type": "mesh3d"
- },
- "ohlc": {
- "animatable": false,
- "attributes": {
- "close": {
- "description": "Sets the close values.",
- "editType": "calc",
- "valType": "data_array"
- },
- "closesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `close`.",
- "editType": "none",
- "valType": "string"
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "decreasing": {
- "editType": "style",
- "line": {
- "color": {
- "description": "Sets the line color.",
- "dflt": "#FF4136",
- "editType": "style",
- "valType": "color"
- },
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
- "dflt": "solid",
- "editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ]
- },
- "editType": "style",
- "role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number"
- }
},
- "role": "object"
- },
- "high": {
- "description": "Sets the high values.",
- "editType": "calc",
- "valType": "data_array"
- },
- "highsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `high`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
"arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
"editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "left",
- "right",
- "auto"
+ "normal",
+ "italic"
]
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
"editType": "none",
"valType": "string"
},
- "bgcolor": {
+ "textcase": {
"arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
"editType": "none",
"valType": "string"
},
- "bordercolor": {
+ "variant": {
"arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
"editType": "none",
"valType": "string"
},
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "parents": {
+ "description": "Sets the parent sectors for each of the sectors. Empty string items '' are understood to reference the root node in the hierarchy. If `ids` is filled, `parents` items are understood to be \"ids\" themselves. When `ids` is not set, plotly attempts to find matching items in `labels`, but beware they must be unique.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "parentssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `parents`.",
"editType": "none",
- "font": {
+ "valType": "string"
+ },
+ "pathbar": {
+ "edgeshape": {
+ "description": "Determines which shape is used for edges between `barpath` labels.",
+ "dflt": ">",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ ">",
+ "<",
+ "|",
+ "/",
+ "\\"
+ ]
+ },
+ "editType": "calc",
+ "role": "object",
+ "side": {
+ "description": "Determines on which side of the the treemap the `pathbar` should be presented.",
+ "dflt": "top",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "bottom"
+ ]
+ },
+ "textfont": {
"color": {
"arrayOk": true,
- "editType": "none",
+ "editType": "plot",
"valType": "color"
},
"colorsrc": {
@@ -53869,12 +51290,12 @@
"editType": "none",
"valType": "string"
},
- "description": "Sets the font used in hover labels.",
- "editType": "none",
+ "description": "Sets the font used inside `pathbar`.",
+ "editType": "plot",
"family": {
"arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -53888,7 +51309,7 @@
"arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "none",
+ "editType": "plot",
"extras": [
"none"
],
@@ -53909,7 +51330,7 @@
"arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "none",
+ "editType": "plot",
"valType": "string"
},
"shadowsrc": {
@@ -53919,7 +51340,7 @@
},
"size": {
"arrayOk": true,
- "editType": "none",
+ "editType": "plot",
"min": 1,
"valType": "number"
},
@@ -53932,7 +51353,7 @@
"arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -53948,7 +51369,7 @@
"arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -53966,7 +51387,7 @@
"arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -53986,7 +51407,7 @@
"arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -54001,285 +51422,33 @@
"valType": "string"
}
},
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "thickness": {
+ "description": "Sets the thickness of `pathbar` (in px). If not specified the `pathbar.textfont.size` is used with 3 pixles extra padding on each side.",
+ "editType": "plot",
+ "min": 12,
+ "valType": "number"
},
- "role": "object",
- "split": {
- "description": "Show hover information (open, close, high, low) in separate labels.",
- "dflt": false,
- "editType": "style",
+ "visible": {
+ "description": "Determines if the path bar is drawn i.e. outside the trace `domain` and with one pixel gap.",
+ "dflt": true,
+ "editType": "plot",
"valType": "boolean"
}
},
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "increasing": {
- "editType": "style",
- "line": {
- "color": {
- "description": "Sets the line color.",
- "dflt": "#3D9970",
- "editType": "style",
- "valType": "color"
- },
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
- "dflt": "solid",
- "editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ]
- },
- "editType": "style",
- "role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number"
- }
- },
- "role": "object"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color"
- },
- "description": "Sets this legend group's title font.",
- "editType": "style",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "style",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "style",
- "valType": "string"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "line": {
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*). Note that this style setting can also be set per direction via `increasing.line.dash` and `decreasing.line.dash`.",
- "dflt": "solid",
- "editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ]
+ "root": {
+ "color": {
+ "description": "sets the color of the root node for a sunburst/treemap/icicle trace. this has no effect when a colorscale is used to set the markers.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color"
},
- "editType": "style",
- "role": "object",
- "width": {
- "description": "[object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number"
- }
- },
- "low": {
- "description": "Sets the low values.",
- "editType": "calc",
- "valType": "data_array"
- },
- "lowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `low`.",
- "editType": "none",
- "valType": "string"
- },
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "open": {
- "description": "Sets the open values.",
- "editType": "calc",
- "valType": "data_array"
- },
- "opensrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `open`.",
- "editType": "none",
- "valType": "string"
- },
- "selectedpoints": {
- "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
"editType": "calc",
- "valType": "any"
+ "role": "object"
},
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "sort": {
+ "description": "Determines whether or not the sectors are reordered from largest to smallest.",
"dflt": true,
- "editType": "style",
+ "editType": "calc",
"valType": "boolean"
},
"stream": {
@@ -54302,24 +51471,234 @@
}
},
"text": {
+ "description": "Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "editType": "plot",
+ "valType": "data_array"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used for `textinfo`.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "textinfo": {
+ "description": "Determines which trace information appear on the graph.",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "value",
+ "current path",
+ "percent root",
+ "percent entry",
+ "percent parent"
+ ],
+ "valType": "flaglist"
+ },
+ "textposition": {
+ "description": "Sets the positions of the `text` elements.",
+ "dflt": "top left",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle left",
+ "middle center",
+ "middle right",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ]
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "texttemplate": {
"arrayOk": true,
- "description": "Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.",
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, `percentParent`, `label` and `value`.",
"dflt": "",
- "editType": "calc",
+ "editType": "plot",
"valType": "string"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
"editType": "none",
"valType": "string"
},
- "tickwidth": {
- "description": "Sets the width of the open/close tick marks relative to the *x* minimal interval.",
- "dflt": 0.3,
+ "tiling": {
"editType": "calc",
- "max": 0.5,
- "min": 0,
- "valType": "number"
+ "flip": {
+ "description": "Determines if the positions obtained from solver are flipped on each axis.",
+ "dflt": "",
+ "editType": "plot",
+ "flags": [
+ "x",
+ "y"
+ ],
+ "valType": "flaglist"
+ },
+ "orientation": {
+ "description": "When set in conjunction with `tiling.flip`, determines on which side the root nodes are drawn in the chart. If `tiling.orientation` is *v* and `tiling.flip` is **, the root nodes appear at the top. If `tiling.orientation` is *v* and `tiling.flip` is *y*, the root nodes appear at the bottom. If `tiling.orientation` is *h* and `tiling.flip` is **, the root nodes appear at the left. If `tiling.orientation` is *h* and `tiling.flip` is *x*, the root nodes appear at the right.",
+ "dflt": "h",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "v",
+ "h"
+ ]
+ },
+ "pad": {
+ "description": "Sets the inner padding (in px).",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object"
},
"transforms": {
"items": {
@@ -54331,8 +51710,9 @@
},
"role": "object"
},
- "type": "ohlc",
+ "type": "icicle",
"uid": {
+ "anim": true,
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string"
@@ -54342,422 +51722,181 @@
"editType": "none",
"valType": "any"
},
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
+ "values": {
+ "description": "Sets the values associated with each of the sectors. Use with `branchvalues` to determine how the values are summed.",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- },
- "x": {
- "description": "Sets the x coordinates. If absent, linear coordinate will be generated.",
- "editType": "calc+clearAxisTypes",
"valType": "data_array"
},
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
+ "valuessrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `values`.",
"editType": "none",
"valType": "string"
},
- "xperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "valType": "any"
- },
- "xperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "xperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
- "dflt": "middle",
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
"editType": "calc",
"valType": "enumerated",
"values": [
- "start",
- "middle",
- "end"
+ true,
+ false,
+ "legendonly"
]
+ }
+ },
+ "categories": [],
+ "layoutAttributes": {
+ "extendiciclecolors": {
+ "description": "If `true`, the icicle slice colors (whether given by `iciclecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
+ "iciclecolorway": {
+ "description": "Sets the default icicle slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendiciclecolors`.",
+ "editType": "calc",
+ "valType": "colorlist"
}
},
- "categories": [
- "cartesian",
- "svg",
- "showLegend"
- ],
"meta": {
- "description": "The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The tip of the lines represent the `low` and `high` values and the horizontal segments represent the `open` and `close` values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red."
+ "description": "Visualize hierarchal data from leaves (and/or outer branches) towards root with rectangles. The icicle sectors are determined by the entries in *labels* or *ids* and in *parents*."
},
- "type": "ohlc"
+ "type": "icicle"
},
- "parcats": {
+ "image": {
"animatable": false,
"attributes": {
- "arrangement": {
- "description": "Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only move along a line perpendicular to the paths. If `freeform`, the categories can freely move on the plane. If `fixed`, the categories and dimensions are stationary.",
- "dflt": "perpendicular",
- "editType": "plot",
+ "colormodel": {
+ "description": "Color model used to map the numerical color components described in `z` into colors. If `source` is specified, this attribute will be set to `rgba256` otherwise it defaults to `rgb`.",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "perpendicular",
- "freeform",
- "fixed"
+ "rgb",
+ "rgba",
+ "rgba256",
+ "hsl",
+ "hsla"
]
},
- "bundlecolors": {
- "description": "Sort paths so that like colors are bundled together within each category.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
- },
- "counts": {
- "arrayOk": true,
- "description": "The number of observations represented by each state. Defaults to 1 so that each state represents one observation",
- "dflt": 1,
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
"editType": "calc",
- "min": 0,
- "valType": "number"
+ "valType": "data_array"
},
- "countssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `counts`.",
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
"editType": "none",
"valType": "string"
},
- "dimensions": {
- "items": {
- "dimension": {
- "categoryarray": {
- "description": "Sets the order in which categories in this dimension appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.",
- "editType": "calc",
- "valType": "data_array"
- },
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
- "categoryorder": {
- "description": "Specifies the ordering logic for the categories in the dimension. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.",
- "dflt": "trace",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "trace",
- "category ascending",
- "category descending",
- "array"
- ]
- },
- "description": "The dimensions (variables) of the parallel categories diagram.",
- "displayindex": {
- "description": "The display index of dimension, from left to right, zero indexed, defaults to dimension index.",
- "editType": "calc",
- "valType": "integer"
- },
- "editType": "calc",
- "label": {
- "description": "The shown name of the dimension.",
- "editType": "calc",
- "valType": "string"
- },
- "role": "object",
- "ticktext": {
- "description": "Sets alternative tick labels for the categories in this dimension. Only has an effect if `categoryorder` is set to *array*. Should be an array the same length as `categoryarray` Used with `categoryorder`.",
- "editType": "calc",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "values": {
- "description": "Dimension values. `values[n]` represents the category value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated).",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
- "visible": {
- "description": "Shows the dimension when set to `true` (the default). Hides the dimension for `false`.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- }
- }
- },
- "role": "object"
+ "dx": {
+ "description": "Set the pixel's horizontal size.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
},
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this parcats trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
+ "dy": {
+ "description": "Set the pixel's vertical size",
+ "dflt": 1,
"editType": "calc",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this parcats trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "x": {
- "description": "Sets the horizontal domain of this parcats trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "y": {
- "description": "Sets the vertical domain of this parcats trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- }
+ "valType": "number"
},
"hoverinfo": {
- "arrayOk": false,
+ "arrayOk": true,
"description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "plot",
+ "dflt": "x+y+z+text+name",
+ "editType": "none",
"extras": [
"all",
"none",
"skip"
],
"flags": [
- "count",
- "probability"
+ "x",
+ "y",
+ "z",
+ "color",
+ "name",
+ "text"
],
"valType": "flaglist"
},
- "hoveron": {
- "description": "Sets the hover interaction mode for the parcats diagram. If `category`, hover interaction take place per category. If `color`, hover interactions take place per color per category. If `dimension`, hover interactions take place across all categories per dimension.",
- "dflt": "category",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "category",
- "color",
- "dimension"
- ]
- },
- "hovertemplate": {
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. This value here applies when hovering over dimensions. Note that `*categorycount`, *colorcount* and *bandcolorcount* are only available when `hoveron` contains the *color* flagFinally, the template string has access to variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "plot",
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
"valType": "string"
},
- "labelfont": {
- "color": {
- "editType": "calc",
- "valType": "color"
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
},
- "description": "Sets the font for the `dimension` labels.",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
"valType": "string"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
},
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
"valType": "string"
},
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "legendgrouptitle": {
- "editType": "style",
+ "editType": "none",
"font": {
"color": {
- "editType": "style",
+ "arrayOk": true,
+ "editType": "none",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
+ "editType": "none",
"noBlank": true,
"strict": true,
"valType": "string"
},
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
"lineposition": {
+ "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "style",
+ "editType": "none",
"extras": [
"none"
],
@@ -54768,32 +51907,56 @@
],
"valType": "flaglist"
},
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
"shadow": {
+ "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "style",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
"valType": "string"
},
"size": {
- "editType": "style",
+ "arrayOk": true,
+ "editType": "none",
"min": 1,
"valType": "number"
},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
"textcase": {
+ "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -54802,10 +51965,16 @@
"lower"
]
},
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -54816,10 +51985,16 @@
"unicase"
]
},
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -54827,295 +52002,688 @@
"max": 1000,
"min": 1,
"valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
"valType": "string"
- }
+ },
+ "role": "object"
},
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `z`, `color` and `colormodel`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "description": "Same as `text`.",
+ "editType": "plot",
+ "valType": "data_array"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
"editType": "style",
- "min": 0,
- "valType": "number"
+ "valType": "subplotid"
},
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
},
- "valType": "number"
- },
- "color": {
- "arrayOk": true,
- "description": "Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.",
- "editType": "calc",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- }
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color"
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
},
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
+ "size": {
+ "editType": "style",
+ "min": 1,
"valType": "number"
},
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
+ "normal",
+ "italic"
]
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "h",
- "v"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "source": {
+ "description": "Specifies the data URI of the image to be visualized. The URI consists of \"data:image/[][;base64],\"",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "text": {
+ "description": "Sets the text elements associated with each z value.",
+ "editType": "plot",
+ "valType": "data_array"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "type": "image",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ },
+ "x0": {
+ "description": "Set the image's x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "valType": "any"
+ },
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "y0": {
+ "description": "Set the image's y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "valType": "any"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "z": {
+ "description": "A 2-dimensional array in which each element is an array of 3 or 4 numbers representing a color.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "zmax": {
+ "description": "Array defining the higher bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [255, 255, 255]. For the `rgba` colormodel, it is [255, 255, 255, 1]. For the `rgba256` colormodel, it is [255, 255, 255, 255]. For the `hsl` colormodel, it is [360, 100, 100]. For the `hsla` colormodel, it is [360, 100, 100, 1].",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "number"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
+ {
+ "editType": "calc",
"valType": "number"
},
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
+ {
+ "editType": "calc",
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "zmin": {
+ "description": "Array defining the lower bound for each color component. Note that the default value will depend on the colormodel. For the `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For the `rgba256` colormodel, it is [0, 0, 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the `hsla` colormodel, it is [0, 0, 0, 0].",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ },
+ "zsmooth": {
+ "description": "Picks a smoothing algorithm used to smooth `z` data. This only applies for image traces that use the `source` attribute.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "fast",
+ false
+ ]
+ },
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "categories": [
+ "cartesian",
+ "svg",
+ "2dMap",
+ "noSortingByValue"
+ ],
+ "meta": {
+ "description": "Display an image, i.e. data on a 2D regular raster. By default, when an image is displayed in a subplot, its y axis will be reversed (ie. `autorange: 'reversed'`), constrained to the domain (ie. `constrain: 'domain'`) and it will have the same scale as its x axis (ie. `scaleanchor: 'x,`) in order for pixels to be rendered as squares."
+ },
+ "type": "image"
+ },
+ "indicator": {
+ "animatable": true,
+ "attributes": {
+ "align": {
+ "description": "Sets the horizontal alignment of the `text` within the box. Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "delta": {
+ "decreasing": {
+ "color": {
+ "description": "Sets the color for increasing value.",
+ "dflt": "#FF4136",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "editType": "plot",
+ "role": "object",
+ "symbol": {
+ "description": "Sets the symbol to display for increasing value",
+ "dflt": "▼",
+ "editType": "plot",
+ "valType": "string"
+ }
+ },
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "plot",
+ "valType": "color"
+ },
+ "description": "Set the font used to display the delta",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "increasing": {
+ "color": {
+ "description": "Sets the color for increasing value.",
+ "dflt": "#3D9970",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "editType": "plot",
+ "role": "object",
+ "symbol": {
+ "description": "Sets the symbol to display for increasing value",
+ "dflt": "▲",
+ "editType": "plot",
+ "valType": "string"
+ }
+ },
+ "position": {
+ "description": "Sets the position of delta with respect to the number.",
+ "dflt": "bottom",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "bottom",
+ "left",
+ "right"
+ ]
+ },
+ "prefix": {
+ "description": "Sets a prefix appearing before the delta.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "reference": {
+ "description": "Sets the reference value to compute the delta. By default, it is set to the current value.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "relative": {
+ "description": "Show relative change",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "suffix": {
+ "description": "Sets a suffix appearing next to the delta.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "valueformat": {
+ "description": "Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
+ "editType": "plot",
+ "valType": "string"
+ }
+ },
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this indicator trace .",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "editType": "calc",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this indicator trace .",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "x": {
+ "description": "Sets the horizontal domain of this indicator trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "y": {
+ "description": "Sets the vertical domain of this indicator trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ }
+ },
+ "gauge": {
+ "axis": {
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "plot",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "plot",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "any"
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "integer"
+ },
+ "range": {
+ "description": "Sets the range of this axis.",
+ "editType": "plot",
+ "items": [
+ {
+ "editType": "plot",
+ "valType": "number"
+ },
+ {
+ "editType": "plot",
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "plot",
"valType": "boolean"
},
"showexponent": {
"description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
"dflt": "all",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"all",
@@ -55127,13 +52695,13 @@
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "colorbars",
+ "editType": "plot",
"valType": "boolean"
},
"showtickprefix": {
"description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
"dflt": "all",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"all",
@@ -55145,7 +52713,7 @@
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
"dflt": "all",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"all",
@@ -55154,26 +52722,9 @@
"none"
]
},
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
"tick0": {
"description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
+ "editType": "plot",
"impliedEdits": {
"tickmode": "linear"
},
@@ -55182,25 +52733,25 @@
"tickangle": {
"description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
"dflt": "auto",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "angle"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "color"
},
"tickfont": {
"color": {
- "editType": "colorbars",
+ "editType": "plot",
"valType": "color"
},
"description": "Sets the color bar's tick label font",
- "editType": "colorbars",
+ "editType": "plot",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -55208,7 +52759,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "plot",
"extras": [
"none"
],
@@ -55223,18 +52774,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "string"
},
"size": {
- "editType": "colorbars",
+ "editType": "plot",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -55244,7 +52795,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -55256,7 +52807,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -55270,7 +52821,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -55283,7 +52834,7 @@
"tickformat": {
"description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
"dflt": "",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "string"
},
"tickformatstops": {
@@ -55291,92 +52842,64 @@
"tickformatstop": {
"dtickrange": {
"description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
+ "editType": "plot",
"items": [
{
- "editType": "colorbars",
+ "editType": "plot",
"valType": "any"
},
{
- "editType": "colorbars",
+ "editType": "plot",
"valType": "any"
}
],
"valType": "info_array"
},
- "editType": "colorbars",
+ "editType": "plot",
"enabled": {
"description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
"dflt": true,
- "editType": "colorbars",
+ "editType": "plot",
"valType": "boolean"
},
"name": {
"description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "string"
},
"role": "object",
"templateitemname": {
"description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "string"
},
"value": {
"description": "string - dtickformat for described zoom level, the same as *tickformat*",
"dflt": "",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "string"
}
}
},
"role": "object"
},
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
- },
"ticklabelstep": {
"description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "plot",
"min": 1,
"valType": "integer"
},
"ticklen": {
"description": "Sets the tick length (in px).",
"dflt": 5,
- "editType": "colorbars",
+ "editType": "plot",
"min": 0,
"valType": "number"
},
"tickmode": {
"description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
+ "editType": "plot",
"impliedEdits": {},
"valType": "enumerated",
"values": [
@@ -55388,13 +52911,13 @@
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "string"
},
"ticks": {
"description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "colorbars",
+ "dflt": "outside",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"outside",
@@ -55405,12 +52928,12 @@
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "string"
},
"ticktext": {
"description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "data_array"
},
"ticktextsrc": {
@@ -55420,7 +52943,7 @@
},
"tickvals": {
"description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "data_array"
},
"tickvalssrc": {
@@ -55431,228 +52954,312 @@
"tickwidth": {
"description": "Sets the tick width (in px).",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "plot",
"min": 0,
"valType": "number"
},
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
+ "visible": {
+ "description": "A single toggle to hide the axis while preserving interaction like dragging. Default is true when a cheater plot is present on the axis, otherwise false",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ }
+ },
+ "bar": {
+ "color": {
+ "description": "Sets the background color of the arc.",
+ "dflt": "green",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "description": "Set the appearance of the gauge's value",
+ "editType": "calc",
+ "line": {
+ "color": {
+ "description": "Sets the color of the line enclosing each sector.",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "description": "Sets the width (in px) of the line enclosing each sector.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object",
+ "thickness": {
+ "description": "Sets the thickness of the bar as a fraction of the total thickness of the gauge.",
+ "dflt": 1,
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the gauge background color.",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the color of the border enclosing the gauge.",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) of the border enclosing the gauge.",
+ "dflt": 1,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
+ "description": "The gauge of the Indicator plot.",
+ "editType": "plot",
+ "role": "object",
+ "shape": {
+ "description": "Set the shape of the gauge",
+ "dflt": "angular",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "angular",
+ "bullet"
+ ]
+ },
+ "steps": {
+ "items": {
+ "step": {
+ "color": {
+ "description": "Sets the background color of the arc.",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "line": {
+ "color": {
+ "description": "Sets the color of the line enclosing each sector.",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "description": "Sets the width (in px) of the line enclosing each sector.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "none",
"valType": "string"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
+ "range": {
+ "description": "Sets the range of this axis.",
+ "editType": "plot",
+ "items": [
+ {
+ "editType": "plot",
+ "valType": "number"
+ },
+ {
+ "editType": "plot",
+ "valType": "number"
+ }
],
- "valType": "flaglist"
+ "valType": "info_array"
},
"role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
"valType": "string"
},
- "size": {
- "editType": "colorbars",
- "min": 1,
+ "thickness": {
+ "description": "Sets the thickness of the bar as a fraction of the total thickness of the gauge.",
+ "dflt": 1,
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
"valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
}
+ }
+ },
+ "role": "object"
+ },
+ "threshold": {
+ "editType": "plot",
+ "line": {
+ "color": {
+ "description": "Sets the color of the threshold line.",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color"
},
+ "editType": "plot",
"role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
- "valType": "string"
+ "width": {
+ "description": "Sets the width (in px) of the threshold line.",
+ "dflt": 1,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
}
},
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
+ "role": "object",
+ "thickness": {
+ "description": "Sets the thickness of the threshold line as a fraction of the thickness of the gauge.",
+ "dflt": 0.85,
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
"valType": "number"
},
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
+ "value": {
+ "description": "Sets a treshold value drawn as a line.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "number"
+ }
+ }
+ },
+ "ids": {
+ "anim": true,
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
"valType": "number"
},
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "normal",
+ "italic"
]
},
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "top",
- "middle",
- "bottom"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
- }
- },
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
},
- "valType": "colorscale"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
},
- "editType": "calc",
- "hovertemplate": {
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. This value here applies when hovering over lines.Finally, the template string has access to variables `count` and `probability`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
"dflt": "",
- "editType": "plot",
+ "editType": "style",
"valType": "string"
- },
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `line.color` is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "role": "object",
- "shape": {
- "description": "Sets the shape of the paths. If `linear`, paths are composed of straight lines. If `hspline`, paths are composed of horizontal curved splines",
- "dflt": "linear",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "linear",
- "hspline"
- ]
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color` is set to a numerical array.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
}
},
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
"meta": {
"arrayOk": true,
"description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
@@ -55664,485 +53271,34 @@
"editType": "none",
"valType": "string"
},
+ "mode": {
+ "description": "Determines how the value is displayed on the graph. `number` displays the value numerically in text. `delta` displays the difference to a reference value in text. Finally, `gauge` displays the value graphically on an axis.",
+ "dflt": "number",
+ "editType": "calc",
+ "flags": [
+ "number",
+ "delta",
+ "gauge"
+ ],
+ "valType": "flaglist"
+ },
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string"
},
- "sortpaths": {
- "description": "Sets the path sorting algorithm. If `forward`, sort paths based on dimension categories from left to right. If `backward`, sort paths based on dimensions categories from right to left.",
- "dflt": "forward",
+ "number": {
"editType": "plot",
- "valType": "enumerated",
- "values": [
- "forward",
- "backward"
- ]
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "tickfont": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Sets the font for the `category` labels.",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "auto",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
- },
- "type": "parcats",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- }
- },
- "categories": [
- "noOpacity"
- ],
- "meta": {
- "description": "Parallel categories diagram for multidimensional categorical data."
- },
- "type": "parcats"
- },
- "parcoords": {
- "animatable": false,
- "attributes": {
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "dimensions": {
- "items": {
- "dimension": {
- "constraintrange": {
- "description": "The domain range to which the filter on the dimension is constrained. Must be an array of `[fromValue, toValue]` with `fromValue <= toValue`, or if `multiselect` is not disabled, you may give an array of arrays, where each inner array is `[fromValue, toValue]`.",
- "dimensions": "1-2",
- "editType": "plot",
- "freeLength": true,
- "items": [
- {
- "editType": "plot",
- "valType": "any"
- },
- {
- "editType": "plot",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "description": "The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported.",
- "editType": "calc",
- "label": {
- "description": "The shown name of the dimension.",
- "editType": "plot",
- "valType": "string"
- },
- "multiselect": {
- "description": "Do we allow multiple selection ranges or just a single range?",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "none",
- "valType": "string"
- },
- "range": {
- "description": "The domain range that represents the full, shown axis extent. Defaults to the `values` extent. Must be an array of `[fromValue, toValue]` with finite numbers as elements.",
- "editType": "plot",
- "items": [
- {
- "editType": "plot",
- "valType": "number"
- },
- {
- "editType": "plot",
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
- "valType": "string"
- },
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`.",
- "editType": "plot",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear.",
- "editType": "plot",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
- "values": {
- "description": "Dimension values. `values[n]` represents the value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated). Each value must be a finite number.",
- "editType": "calc",
- "valType": "data_array"
- },
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
- "visible": {
- "description": "Shows the dimension when set to `true` (the default). Hides the dimension for `false`.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
- }
- }
- },
- "role": "object"
- },
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this parcoords trace .",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "integer"
- },
- "editType": "plot",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this parcoords trace .",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "integer"
- },
- "x": {
- "description": "Sets the horizontal domain of this parcoords trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "plot",
- "items": [
- {
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "y": {
- "description": "Sets the vertical domain of this parcoords trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "plot",
- "items": [
- {
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- }
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "labelangle": {
- "description": "Sets the angle of the labels with respect to the horizontal. For example, a `tickangle` of -90 draws the labels vertically. Tilted labels with *labelangle* may be positioned better inside margins when `labelposition` is set to *bottom*.",
- "dflt": 0,
- "editType": "plot",
- "valType": "angle"
- },
- "labelfont": {
- "color": {
- "editType": "plot",
- "valType": "color"
- },
- "description": "Sets the font for the `dimension` labels.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "labelside": {
- "description": "Specifies the location of the `label`. *top* positions labels above, next to the title *bottom* positions labels below the graph Tilted labels with *labelangle* may be positioned better inside margins when `labelposition` is set to *bottom*.",
- "dflt": "top",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "top",
- "bottom"
- ]
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgrouptitle": {
- "editType": "style",
"font": {
"color": {
- "editType": "style",
+ "editType": "plot",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
+ "description": "Set the font used to display main number",
+ "editType": "plot",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -56150,7 +53306,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "style",
+ "editType": "plot",
"extras": [
"none"
],
@@ -56165,18 +53321,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "style",
+ "editType": "plot",
"valType": "string"
},
"size": {
- "editType": "style",
+ "editType": "plot",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "style",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -56186,7 +53342,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "style",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -56198,7 +53354,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -56212,7 +53368,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -56222,384 +53378,327 @@
"valType": "integer"
}
},
+ "prefix": {
+ "description": "Sets a prefix appearing before the number.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
"role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
+ "suffix": {
+ "description": "Sets a suffix appearing next to the number.",
"dflt": "",
- "editType": "style",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "valueformat": {
+ "description": "Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
+ "dflt": "",
+ "editType": "plot",
"valType": "string"
}
},
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": false,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.",
- "dflt": null,
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
"editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
+ "max": 10000,
+ "min": 0,
"valType": "number"
},
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.",
- "dflt": null,
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
"editType": "calc",
- "impliedEdits": {},
- "valType": "number"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "title": {
+ "align": {
+ "description": "Sets the horizontal alignment of the title. It defaults to `center` except for bullet charts for which it defaults to right.",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
+ "editType": "plot",
+ "font": {
+ "color": {
+ "editType": "plot",
+ "valType": "color"
},
- "valType": "number"
- },
- "color": {
- "arrayOk": true,
- "description": "Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.",
- "editType": "calc",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- }
+ "description": "Set the font used to display the title",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color"
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
},
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
+ "size": {
+ "editType": "plot",
+ "min": 1,
"valType": "number"
},
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
+ "normal",
+ "italic"
]
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "h",
- "v"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of this indicator.",
+ "editType": "plot",
+ "valType": "string"
+ }
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
+ "type": "indicator",
+ "uid": {
+ "anim": true,
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "value": {
+ "anim": true,
+ "description": "Sets the number to be displayed.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ }
+ },
+ "categories": [
+ "svg",
+ "noOpacity",
+ "noHover"
+ ],
+ "meta": {
+ "description": "An indicator is used to visualize a single `value` along with some contextual information such as `steps` or a `threshold`, using a combination of three visual elements: a number, a delta, and/or a gauge. Deltas are taken with respect to a `reference`. Gauges can be either angular or bullet (aka linear) gauges."
+ },
+ "type": "indicator"
+ },
+ "isosurface": {
+ "animatable": false,
+ "attributes": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "caps": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
+ "editType": "calc",
+ "fill": {
+ "description": "Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "calc",
+ "max": 1,
"min": 0,
"valType": "number"
},
"role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
+ "show": {
+ "description": "Sets the fill ratio of the `slices`. The default fill value of the x `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
+ "dflt": true,
+ "editType": "calc",
"valType": "boolean"
+ }
+ },
+ "y": {
+ "editType": "calc",
+ "fill": {
+ "description": "Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
+ "role": "object",
+ "show": {
+ "description": "Sets the fill ratio of the `slices`. The default fill value of the y `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
"dflt": true,
- "editType": "colorbars",
+ "editType": "calc",
"valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
+ }
+ },
+ "z": {
+ "editType": "calc",
+ "fill": {
+ "description": "Sets the fill ratio of the `caps`. The default fill value of the `caps` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "role": "object",
+ "show": {
+ "description": "Sets the fill ratio of the `slices`. The default fill value of the z `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ }
+ }
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here `value`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as `value` and if set, `cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `value`. Has no effect when `cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as `value` and if set, `cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "calc",
+ "valType": "string"
},
- "tickfont": {
+ "titlefont": {
"color": {
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "calc",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
+ "editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -56607,7 +53706,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"none"
],
@@ -56618,22 +53717,21 @@
],
"valType": "flaglist"
},
- "role": "object",
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"size": {
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -56643,7 +53741,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -56655,7 +53753,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -56669,7 +53767,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"normal",
"bold"
@@ -56679,952 +53777,687 @@
"valType": "integer"
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "allow",
- "hide past div",
- "hide past domain"
+ "right",
+ "top",
+ "bottom"
]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
},
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
+ "valType": "any"
+ },
+ "editType": "calc",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
},
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 1,
- "valType": "integer"
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
+ "description": "Sets the color bar's tick label font",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
"valType": "number"
},
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
- "impliedEdits": {},
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "auto",
- "linear",
- "array"
+ "normal",
+ "italic"
]
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "colorbars",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "any"
+ },
+ {
+ "editType": "calc",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
},
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "editType": "calc",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "calc",
+ "valType": "string"
},
"role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
"valType": "string"
},
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
}
+ }
+ },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
+ },
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
"role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "right",
- "top",
- "bottom"
+ "normal",
+ "italic"
]
},
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
- "valType": "string"
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "calc",
"valType": "enumerated",
"values": [
+ "right",
"top",
- "middle",
"bottom"
]
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "calc",
+ "valType": "string"
}
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": [
- [
- 0,
- "#440154"
- ],
- [
- 0.06274509803921569,
- "#48186a"
- ],
- [
- 0.12549019607843137,
- "#472d7b"
- ],
- [
- 0.18823529411764706,
- "#424086"
- ],
- [
- 0.25098039215686274,
- "#3b528b"
- ],
- [
- 0.3137254901960784,
- "#33638d"
- ],
- [
- 0.3764705882352941,
- "#2c728e"
- ],
- [
- 0.4392156862745098,
- "#26828e"
- ],
- [
- 0.5019607843137255,
- "#21918c"
- ],
- [
- 0.5647058823529412,
- "#1fa088"
- ],
- [
- 0.6274509803921569,
- "#28ae80"
- ],
- [
- 0.6901960784313725,
- "#3fbc73"
- ],
- [
- 0.7529411764705882,
- "#5ec962"
- ],
- [
- 0.8156862745098039,
- "#84d44b"
- ],
- [
- 0.8784313725490196,
- "#addc30"
- ],
- [
- 0.9411764705882353,
- "#d8e219"
- ],
- [
- 1,
- "#fde725"
- ]
- ],
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
"editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
+ "valType": "number"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
},
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `line.color` is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "contour": {
+ "color": {
+ "description": "Sets the color of the contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
},
+ "editType": "calc",
"role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color` is set to a numerical array.",
+ "show": {
+ "description": "Sets whether or not dynamic contours are shown on hover",
"dflt": false,
"editType": "calc",
"valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width of the contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number"
}
},
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
"editType": "none",
"valType": "string"
},
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "rangefont": {
- "color": {
- "editType": "plot",
- "valType": "color"
- },
- "description": "Sets the font for the `dimension` range values.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "tickfont": {
- "color": {
- "editType": "plot",
- "valType": "color"
- },
- "description": "Sets the font for the `dimension` tick values.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "auto",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
- },
- "type": "parcoords",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "unselected": {
- "editType": "plot",
- "line": {
- "color": {
- "description": "Sets the base color of unselected lines. in connection with `unselected.line.opacity`.",
- "dflt": "#7f7f7f",
- "editType": "plot",
- "valType": "color"
- },
- "editType": "plot",
- "opacity": {
- "description": "Sets the opacity of unselected lines. The default *auto* decreases the opacity smoothly as the number of lines increases. Use *1* to achieve exact `unselected.line.color`.",
- "dflt": "auto",
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object"
- },
- "role": "object"
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- }
- },
- "categories": [
- "gl",
- "regl",
- "noOpacity",
- "noHover"
- ],
- "meta": {
- "description": "Parallel coordinates for multidimensional exploratory data analysis. The samples are specified in `dimensions`. The colors are set in `line.color`."
- },
- "type": "parcoords"
- },
- "pie": {
- "animatable": false,
- "attributes": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of `title.text`. Note that value of `title` is no longer a simple *string* but a set of sub-attributes.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
- },
- "description": "Deprecated in favor of `title.font`.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleposition": {
- "description": "Deprecated in favor of `title.position`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "top left",
- "top center",
- "top right",
- "middle center",
- "bottom left",
- "bottom center",
- "bottom right"
- ]
- }
- },
- "automargin": {
- "description": "Determines whether outside text labels can push the margins.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "direction": {
- "description": "Specifies the direction at which succeeding sectors follow one another.",
- "dflt": "counterclockwise",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "clockwise",
- "counterclockwise"
- ]
- },
- "dlabel": {
- "description": "Sets the label step. See `label0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this pie trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "editType": "calc",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this pie trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "x": {
- "description": "Sets the horizontal domain of this pie trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "y": {
- "description": "Sets the vertical domain of this pie trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- }
- },
- "hole": {
- "description": "Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.",
- "dflt": 0,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "flatshading": {
+ "description": "Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
},
"hoverinfo": {
"arrayOk": true,
"description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
"dflt": "all",
- "editType": "none",
+ "editType": "calc",
"extras": [
"all",
"none",
"skip"
],
"flags": [
- "label",
+ "x",
+ "y",
+ "z",
"text",
- "value",
- "percent",
"name"
],
"valType": "flaglist"
@@ -57835,9 +54668,9 @@
},
"hovertemplate": {
"arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `percent` and `text`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
"dflt": "",
- "editType": "none",
+ "editType": "calc",
"valType": "string"
},
"hovertemplatesrc": {
@@ -57847,9 +54680,9 @@
},
"hovertext": {
"arrayOk": true,
- "description": "Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "description": "Same as `text`.",
"dflt": "",
- "editType": "style",
+ "editType": "calc",
"valType": "string"
},
"hovertextsrc": {
@@ -57867,176 +54700,15 @@
"editType": "none",
"valType": "string"
},
- "insidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `textinfo` lying inside the sector.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "insidetextorientation": {
- "description": "Controls the orientation of the text inside chart sectors. When set to *auto*, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The *horizontal* option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The *radial* option orients text along the radius of the sector. The *tangential* option orients text perpendicular to the radius of the sector.",
- "dflt": "auto",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "horizontal",
- "radial",
- "tangential",
- "auto"
- ]
- },
- "label0": {
- "description": "Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.",
- "dflt": 0,
+ "isomax": {
+ "description": "Sets the maximum boundary for iso-surface plot.",
"editType": "calc",
"valType": "number"
},
- "labels": {
- "description": "Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.",
+ "isomin": {
+ "description": "Sets the minimum boundary for iso-surface plot.",
"editType": "calc",
- "valType": "data_array"
- },
- "labelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
- "editType": "none",
- "valType": "string"
+ "valType": "number"
},
"legend": {
"description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
@@ -58161,141 +54833,93 @@
"min": 0,
"valType": "number"
},
- "marker": {
- "colors": {
- "description": "Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.",
+ "lighting": {
+ "ambient": {
+ "description": "Ambient light increases overall color visibility but can wash out the image.",
+ "dflt": 0.8,
"editType": "calc",
- "valType": "data_array"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "colorssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
- "editType": "none",
- "valType": "string"
+ "diffuse": {
+ "description": "Represents the extent that incident rays are reflected in a range of angles.",
+ "dflt": 0.8,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
"editType": "calc",
- "line": {
- "color": {
- "arrayOk": true,
- "description": "Sets the color of the line enclosing each sector.",
- "dflt": "#444",
- "editType": "style",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
+ "facenormalsepsilon": {
+ "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 0,
"editType": "calc",
- "role": "object",
- "width": {
- "arrayOk": true,
- "description": "Sets the width (in px) of the line enclosing each sector.",
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- }
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "pattern": {
- "bgcolor": {
- "arrayOk": true,
- "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
- "editType": "style",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the pattern within the marker.",
- "editType": "style",
- "fgcolor": {
- "arrayOk": true,
- "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
- "editType": "style",
- "valType": "color"
- },
- "fgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "fgopacity": {
- "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "fillmode": {
- "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
- "dflt": "replace",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "replace",
- "overlay"
- ]
- },
- "role": "object",
- "shape": {
- "arrayOk": true,
- "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
- "dflt": "",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "",
- "/",
- "\\",
- "x",
- "-",
- "|",
- "+",
- "."
- ]
- },
- "shapesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
- "dflt": 8,
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "solidity": {
- "arrayOk": true,
- "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
- "dflt": 0.3,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- }
+ "fresnel": {
+ "description": "Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.",
+ "dflt": 0.2,
+ "editType": "calc",
+ "max": 5,
+ "min": 0,
+ "valType": "number"
},
- "role": "object"
+ "role": "object",
+ "roughness": {
+ "description": "Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.",
+ "dflt": 0.5,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "specular": {
+ "description": "Represents the level that incident rays are reflected in a single direction, causing shine.",
+ "dflt": 0.05,
+ "editType": "calc",
+ "max": 2,
+ "min": 0,
+ "valType": "number"
+ },
+ "vertexnormalsepsilon": {
+ "description": "Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 1e-12,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "lightposition": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
+ "description": "Numeric vector, representing the X coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ },
+ "y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ },
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ }
},
"meta": {
"arrayOk": true,
@@ -58314,193 +54938,145 @@
"valType": "string"
},
"opacity": {
- "description": "Sets the opacity of the trace.",
+ "description": "Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.",
"dflt": 1,
- "editType": "style",
+ "editType": "calc",
"max": 1,
"min": 0,
"valType": "number"
},
- "outsidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `textinfo` lying outside the sector.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "scene": {
+ "description": "Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.",
+ "dflt": "scene",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "slices": {
+ "editType": "calc",
"role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
+ "x": {
+ "editType": "calc",
+ "fill": {
+ "description": "Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "locations": {
+ "description": "Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "locationssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not slice planes about the x dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ }
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "y": {
+ "editType": "calc",
+ "fill": {
+ "description": "Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "locations": {
+ "description": "Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "locationssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not slice planes about the y dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ }
},
- "size": {
- "arrayOk": true,
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "z": {
+ "editType": "calc",
+ "fill": {
+ "description": "Sets the fill ratio of the `slices`. The default fill value of the `slices` is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "locations": {
+ "description": "Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "locationssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not slice planes about the z dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ }
}
},
- "pull": {
- "arrayOk": true,
- "description": "Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.",
- "dflt": 0,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "pullsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `pull`.",
- "editType": "none",
- "valType": "string"
- },
- "rotation": {
- "description": "Instead of the first slice starting at 12 o'clock, rotate to some other angle.",
- "dflt": 0,
- "editType": "calc",
- "valType": "angle"
- },
- "scalegroup": {
- "description": "If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean"
- },
- "sort": {
- "description": "Determines whether or not the sectors are reordered from largest to smallest.",
- "dflt": true,
+ "spaceframe": {
"editType": "calc",
- "valType": "boolean"
+ "fill": {
+ "description": "Sets the fill ratio of the `spaceframe` elements. The default fill value is 0.15 meaning that only 15% of the area of every faces of tetras would be shaded. Applying a greater `fill` ratio would allow the creation of stronger elements or could be sued to have entirely closed areas (in case of using 1).",
+ "dflt": 0.15,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "show": {
+ "description": "Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ }
},
"stream": {
"editType": "calc",
@@ -58521,296 +55097,566 @@
"valType": "string"
}
},
- "text": {
- "description": "Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "editType": "plot",
- "valType": "data_array"
- },
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `textinfo`.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "surface": {
+ "count": {
+ "description": "Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 1,
+ "valType": "integer"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "editType": "calc",
+ "fill": {
+ "description": "Sets the fill ratio of the iso-surface. The default fill value of the surface is 1 meaning that they are entirely shaded. On the other hand Applying a `fill` ratio less than one would allow the creation of openings parallel to the edges.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
+ "pattern": {
+ "description": "Sets the surface pattern of the iso-surface 3-D sections. The default pattern of the surface is `all` meaning that the rest of surface elements would be shaded. The check options (either 1 or 2) could be used to draw half of the squares on the surface. Using various combinations of capital `A`, `B`, `C`, `D` and `E` may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest.",
+ "dflt": "all",
+ "editType": "calc",
"extras": [
- "none"
+ "all",
+ "odd",
+ "even"
],
"flags": [
- "under",
- "over",
- "through"
+ "A",
+ "B",
+ "C",
+ "D",
+ "E"
],
"valType": "flaglist"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "plot",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "show": {
+ "description": "Hides/displays surfaces between minimum and maximum iso-values.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
}
},
- "textinfo": {
- "description": "Determines which trace information appear on the graph.",
+ "text": {
+ "arrayOk": true,
+ "description": "Sets the text elements associated with the vertices. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
"editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "label",
- "text",
- "value",
- "percent"
- ],
- "valType": "flaglist"
+ "valType": "string"
},
- "textposition": {
- "arrayOk": true,
- "description": "Specifies the location of the `textinfo`.",
- "dflt": "auto",
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "type": "isosurface",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "value": {
+ "description": "Sets the 4th dimension (value) of the vertices.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "valuehoverformat": {
+ "description": "Sets the hover text formatting rulefor `value` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "valuesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `value`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "inside",
- "outside",
- "auto",
- "none"
+ true,
+ false,
+ "legendonly"
]
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "x": {
+ "description": "Sets the X coordinates of the vertices on X axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
"editType": "none",
"valType": "string"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "y": {
+ "description": "Sets the Y coordinates of the vertices on Y axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
"editType": "none",
"valType": "string"
},
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `percent` and `text`.",
+ "z": {
+ "description": "Sets the Z coordinates of the vertices on Z axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `zaxis.hoverformat`.",
"dflt": "",
- "editType": "plot",
+ "editType": "calc",
"valType": "string"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
"editType": "none",
"valType": "string"
+ }
+ },
+ "categories": [
+ "gl3d",
+ "showLegend"
+ ],
+ "meta": {
+ "description": "Draws isosurfaces between iso-min and iso-max values with coordinates given by four 1-dimensional arrays containing the `value`, `x`, `y` and `z` of every vertex of a uniform or non-uniform 3-D grid. Horizontal or vertical slices, caps as well as spaceframe between iso-min and iso-max values could also be drawn using this trace."
+ },
+ "type": "isosurface"
+ },
+ "mesh3d": {
+ "animatable": false,
+ "attributes": {
+ "alphahull": {
+ "description": "Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays are not supplied. For general use of `mesh3d` it is preferred that `i`, `j`, `k` are supplied. If *-1*, Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to `delaunayaxis`. In case the `delaunayaxis` intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of `delaunayaxis`. If *>0*, the alpha-shape algorithm is used. In this case, the positive `alphahull` value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If *0*, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the `x`, `y` and `z` point set into a convex hull.",
+ "dflt": -1,
+ "editType": "calc",
+ "valType": "number"
},
- "title": {
- "editType": "plot",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "plot",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "plot",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here `intensity`) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Value should have the same units as `intensity` and if set, `cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `cmin` and/or `cmax` to be equidistant to this point. Value should have the same units as `intensity`. Has no effect when `cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Value should have the same units as `intensity` and if set, `cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "description": "Sets the color of the whole mesh",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "arrayOk": true,
- "editType": "plot",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"style": {
- "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
"textcase": {
- "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -58819,16 +55665,10 @@
"lower"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -58839,16 +55679,10 @@
"unicase"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -58856,129 +55690,411 @@
"max": 1000,
"min": 1,
"valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
}
},
- "position": {
- "description": "Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.",
- "editType": "plot",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "top left",
- "top center",
- "top right",
- "middle center",
- "bottom left",
- "bottom center",
- "bottom right"
+ "allow",
+ "hide past div",
+ "hide past domain"
]
},
- "role": "object",
- "text": {
- "description": "Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- }
- },
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
- },
- "type": "pie",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
},
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
},
- "values": {
- "description": "Sets the values of the sectors. If omitted, we count occurrences of each label.",
+ "contour": {
+ "color": {
+ "description": "Sets the color of the contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object",
+ "show": {
+ "description": "Sets whether or not dynamic contours are shown on hover",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width of the contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number"
+ }
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
"editType": "calc",
"valType": "data_array"
},
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
"editType": "none",
"valType": "string"
},
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
+ "delaunayaxis": {
+ "description": "Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if `i`, `j`, `k` are not provided and `alphahull` is set to indicate Delaunay triangulation.",
+ "dflt": "z",
"editType": "calc",
"valType": "enumerated",
"values": [
- true,
- false,
- "legendonly"
+ "x",
+ "y",
+ "z"
]
- }
- },
- "categories": [
- "pie-like",
- "pie",
- "showLegend"
- ],
- "layoutAttributes": {
- "extendpiecolors": {
- "description": "If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
},
- "hiddenlabels": {
- "description": "hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts",
+ "facecolor": {
+ "description": "Sets the color of each face Overrides *color* and *vertexcolor*.",
"editType": "calc",
"valType": "data_array"
},
- "hiddenlabelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hiddenlabels`.",
+ "facecolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `facecolor`.",
"editType": "none",
"valType": "string"
},
- "piecolorway": {
- "description": "Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`.",
- "editType": "calc",
- "valType": "colorlist"
- }
- },
- "meta": {
- "description": "A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`"
- },
- "type": "pie"
- },
- "pointcloud": {
- "animatable": false,
- "attributes": {
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "flatshading": {
+ "description": "Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.",
+ "dflt": false,
"editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "valType": "boolean"
},
"hoverinfo": {
"arrayOk": true,
"description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
"dflt": "all",
- "editType": "none",
+ "editType": "calc",
"extras": [
"all",
"none",
@@ -59197,6 +56313,35 @@
},
"role": "object"
},
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Same as `text`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "i": {
+ "description": "A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *first* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `i[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `i` represents a point in space, which is the first vertex of a triangle.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
"ids": {
"description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
"editType": "calc",
@@ -59207,13 +56352,48 @@
"editType": "none",
"valType": "string"
},
- "indices": {
- "description": "A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call.",
+ "intensity": {
+ "description": "Sets the intensity values for vertices or cells as defined by `intensitymode`. It can be used for plotting fields on meshes.",
"editType": "calc",
"valType": "data_array"
},
- "indicessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `indices`.",
+ "intensitymode": {
+ "description": "Determines the source of `intensity` values.",
+ "dflt": "vertex",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "vertex",
+ "cell"
+ ]
+ },
+ "intensitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `intensity`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "isrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `i`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "j": {
+ "description": "A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *second* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `j[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `j` represents a point in space, which is the second vertex of a triangle.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "jsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `j`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "k": {
+ "description": "A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the *third* vertex of a triangle. For example, `{i[m], j[m], k[m]}` together represent face m (triangle m) in the mesh, where `k[m] = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, each element in `k` represents a point in space, which is the third vertex of a triangle.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "ksrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `k`.",
"editType": "none",
"valType": "string"
},
@@ -59340,65 +56520,95 @@
"min": 0,
"valType": "number"
},
- "marker": {
- "blend": {
- "description": "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.",
- "dflt": null,
- "editType": "calc",
- "valType": "boolean"
- },
- "border": {
- "arearatio": {
- "description": "Specifies what fraction of the marker area is covered with the border.",
- "dflt": 0,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "color": {
- "arrayOk": false,
- "description": "Sets the stroke color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.",
- "editType": "calc",
- "valType": "color"
- },
+ "lighting": {
+ "ambient": {
+ "description": "Ambient light increases overall color visibility but can wash out the image.",
+ "dflt": 0.8,
"editType": "calc",
- "role": "object"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "color": {
- "arrayOk": false,
- "description": "Sets the marker fill color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.",
+ "diffuse": {
+ "description": "Represents the extent that incident rays are reflected in a range of angles.",
+ "dflt": 0.8,
"editType": "calc",
- "valType": "color"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
"editType": "calc",
- "opacity": {
- "arrayOk": false,
- "description": "Sets the marker opacity. The default value is `1` (fully opaque). If the markers are not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning. Opacity fades the color even if `blend` is left on `false` even if there is no translucency effect in that case.",
- "dflt": 1,
+ "facenormalsepsilon": {
+ "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 0.000001,
"editType": "calc",
"max": 1,
"min": 0,
"valType": "number"
},
- "role": "object",
- "sizemax": {
- "description": "Sets the maximum size (in px) of the rendered marker points. Effective when the `pointcloud` shows only few points.",
- "dflt": 20,
+ "fresnel": {
+ "description": "Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.",
+ "dflt": 0.2,
"editType": "calc",
- "min": 0.1,
+ "max": 5,
+ "min": 0,
"valType": "number"
},
- "sizemin": {
- "description": "Sets the minimum size (in px) of the rendered marker points, effective when the `pointcloud` shows a million or more points.",
+ "role": "object",
+ "roughness": {
+ "description": "Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.",
"dflt": 0.5,
"editType": "calc",
- "max": 2,
- "min": 0.1,
+ "max": 1,
+ "min": 0,
"valType": "number"
- }
- },
- "meta": {
+ },
+ "specular": {
+ "description": "Represents the level that incident rays are reflected in a single direction, causing shine.",
+ "dflt": 0.05,
+ "editType": "calc",
+ "max": 2,
+ "min": 0,
+ "valType": "number"
+ },
+ "vertexnormalsepsilon": {
+ "description": "Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 1e-12,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "lightposition": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
+ "description": "Numeric vector, representing the X coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ },
+ "y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ },
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number"
+ }
+ },
+ "meta": {
"arrayOk": true,
"description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
"editType": "plot",
@@ -59415,19 +56625,37 @@
"valType": "string"
},
"opacity": {
- "description": "Sets the opacity of the trace.",
+ "description": "Sets the opacity of the surface. Please note that in the case of using high `opacity` values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.",
"dflt": 1,
- "editType": "style",
+ "editType": "calc",
"max": 1,
"min": 0,
"valType": "number"
},
+ "reversescale": {
+ "description": "Reverses the color mapping if true. If true, `cmin` will correspond to the last color in the array and `cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "scene": {
+ "description": "Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.",
+ "dflt": "scene",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
+ "dflt": false,
"editType": "style",
"valType": "boolean"
},
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
"stream": {
"editType": "calc",
"maxpoints": {
@@ -59449,7 +56677,7 @@
},
"text": {
"arrayOk": true,
- "description": "Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "description": "Sets the text elements associated with the vertices. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"dflt": "",
"editType": "calc",
"valType": "string"
@@ -59459,7 +56687,7 @@
"editType": "none",
"valType": "string"
},
- "type": "pointcloud",
+ "type": "mesh3d",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -59470,6 +56698,16 @@
"editType": "none",
"valType": "any"
},
+ "vertexcolor": {
+ "description": "Sets the color of each vertex Overrides *color*. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "vertexcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `vertexcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
"dflt": true,
@@ -59482,23 +56720,37 @@
]
},
"x": {
- "description": "Sets the x coordinates.",
+ "description": "Sets the X coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.",
"editType": "calc+clearAxisTypes",
"valType": "data_array"
},
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "xbounds": {
- "description": "Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits.",
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
"editType": "calc",
- "valType": "data_array"
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
},
- "xboundssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `xbounds`.",
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
"editType": "none",
"valType": "string"
},
@@ -59507,67 +56759,108 @@
"editType": "none",
"valType": "string"
},
- "xy": {
- "description": "Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`",
- "editType": "calc",
+ "y": {
+ "description": "Sets the Y coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array"
},
- "xysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `xy`.",
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
"editType": "none",
"valType": "string"
},
- "y": {
- "description": "Sets the y coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
+ "valType": "string"
},
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
+ "z": {
+ "description": "Sets the Z coordinates of the vertices. The nth element of vectors `x`, `y` and `z` jointly represent the X, Y and Z coordinates of the nth vertex.",
"editType": "calc+clearAxisTypes",
- "valType": "subplotid"
+ "valType": "data_array"
},
- "ybounds": {
- "description": "Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits.",
+ "zcalendar": {
+ "description": "Sets the calendar system to use with `z` date data.",
+ "dflt": "gregorian",
"editType": "calc",
- "valType": "data_array"
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
},
- "yboundssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ybounds`.",
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `zaxis.hoverformat`.",
+ "dflt": "",
"editType": "none",
"valType": "string"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
"editType": "none",
"valType": "string"
}
},
"categories": [
- "gl",
- "gl2d",
+ "gl3d",
"showLegend"
],
"meta": {
- "description": "*pointcloud* trace is deprecated! Please consider switching to the *scattergl* trace type. The data visualized as a point cloud set in `x` and `y` using the WebGl plotting engine."
+ "description": "Draws sets of triangles with coordinates given by three 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-shape algorithm or (4) the Convex-hull algorithm"
},
- "type": "pointcloud"
+ "type": "mesh3d"
},
- "sankey": {
+ "ohlc": {
"animatable": false,
"attributes": {
- "arrangement": {
- "description": "If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via `nodepad`. If value is `perpendicular`, the nodes can only move along a line perpendicular to the flow. If value is `freeform`, the nodes can freely move on the plane. If value is `fixed`, the nodes are stationary.",
- "dflt": "snap",
+ "close": {
+ "description": "Sets the close values.",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "snap",
- "perpendicular",
- "freeform",
- "fixed"
- ]
+ "valType": "data_array"
+ },
+ "closesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `close`.",
+ "editType": "none",
+ "valType": "string"
},
"customdata": {
"description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
@@ -59579,89 +56872,81 @@
"editType": "none",
"valType": "string"
},
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this sankey trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
+ "decreasing": {
+ "editType": "style",
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
+ "dflt": "#FF4136",
+ "editType": "style",
+ "valType": "color"
+ },
+ "dash": {
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
+ "dflt": "solid",
+ "editType": "style",
+ "valType": "string",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ]
+ },
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ }
},
+ "role": "object"
+ },
+ "high": {
+ "description": "Sets the high values.",
"editType": "calc",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this sankey trace .",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "x": {
- "description": "Sets the horizontal domain of this sankey trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- },
- "y": {
- "description": "Sets the vertical domain of this sankey trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array"
- }
+ "valType": "data_array"
+ },
+ "highsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `high`.",
+ "editType": "none",
+ "valType": "string"
},
"hoverinfo": {
- "arrayOk": false,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively.",
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
"dflt": "all",
- "editType": "calc",
+ "editType": "none",
"extras": [
"all",
"none",
"skip"
],
- "flags": [],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
"valType": "flaglist"
},
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
"hoverlabel": {
"align": {
"arrayOk": true,
"description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
"dflt": "auto",
- "editType": "calc",
+ "editType": "none",
"valType": "enumerated",
"values": [
"left",
@@ -59677,7 +56962,7 @@
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
- "editType": "calc",
+ "editType": "none",
"valType": "color"
},
"bgcolorsrc": {
@@ -59688,7 +56973,7 @@
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
- "editType": "calc",
+ "editType": "none",
"valType": "color"
},
"bordercolorsrc": {
@@ -59696,11 +56981,11 @@
"editType": "none",
"valType": "string"
},
- "editType": "calc",
+ "editType": "none",
"font": {
"color": {
"arrayOk": true,
- "editType": "calc",
+ "editType": "none",
"valType": "color"
},
"colorsrc": {
@@ -59709,11 +56994,11 @@
"valType": "string"
},
"description": "Sets the font used in hover labels.",
- "editType": "calc",
+ "editType": "none",
"family": {
"arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
+ "editType": "none",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -59727,7 +57012,7 @@
"arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "calc",
+ "editType": "none",
"extras": [
"none"
],
@@ -59748,7 +57033,7 @@
"arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "calc",
+ "editType": "none",
"valType": "string"
},
"shadowsrc": {
@@ -59758,7 +57043,7 @@
},
"size": {
"arrayOk": true,
- "editType": "calc",
+ "editType": "none",
"min": 1,
"valType": "number"
},
@@ -59771,7 +57056,7 @@
"arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -59787,7 +57072,7 @@
"arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -59805,7 +57090,7 @@
"arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -59825,7 +57110,7 @@
"arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -59844,7 +57129,7 @@
"arrayOk": true,
"description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
"dflt": 15,
- "editType": "calc",
+ "editType": "none",
"min": -1,
"valType": "integer"
},
@@ -59853,7 +57138,25 @@
"editType": "none",
"valType": "string"
},
- "role": "object"
+ "role": "object",
+ "split": {
+ "description": "Show hover information (open, close, high, low) in separate labels.",
+ "dflt": false,
+ "editType": "style",
+ "valType": "boolean"
+ }
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Same as `text`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
},
"ids": {
"description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
@@ -59865,12 +57168,53 @@
"editType": "none",
"valType": "string"
},
+ "increasing": {
+ "editType": "style",
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
+ "dflt": "#3D9970",
+ "editType": "style",
+ "valType": "color"
+ },
+ "dash": {
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
+ "dflt": "solid",
+ "editType": "style",
+ "valType": "string",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ]
+ },
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object"
+ },
"legend": {
"description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
"dflt": "legend",
"editType": "style",
"valType": "subplotid"
},
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
"legendgrouptitle": {
"editType": "style",
"font": {
@@ -59982,551 +57326,1013 @@
"min": 0,
"valType": "number"
},
- "link": {
- "arrowlen": {
- "description": "Sets the length (in px) of the links arrow, if 0 no arrow will be drawn.",
- "dflt": 0,
- "editType": "calc",
+ "line": {
+ "dash": {
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*). Note that this style setting can also be set per direction via `increasing.line.dash` and `decreasing.line.dash`.",
+ "dflt": "solid",
+ "editType": "style",
+ "valType": "string",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ]
+ },
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "[object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.",
+ "dflt": 2,
+ "editType": "style",
"min": 0,
"valType": "number"
- },
- "color": {
- "arrayOk": true,
- "description": "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.",
- "editType": "calc",
- "valType": "color"
- },
- "colorscales": {
- "items": {
- "concentrationscales": {
- "cmax": {
- "description": "Sets the upper bound of the color domain.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain.",
- "dflt": 0,
- "editType": "calc",
- "valType": "number"
- },
- "colorscale": {
- "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": [
- [
- 0,
- "white"
- ],
- [
- 1,
- "black"
- ]
- ],
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "editType": "calc",
- "label": {
- "description": "The label of the links to color based on their concentration within a flow.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "calc",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "customdata": {
- "description": "Assigns extra data to each link.",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "The links of the Sankey plot.",
+ }
+ },
+ "low": {
+ "description": "Sets the low values.",
"editType": "calc",
- "hovercolor": {
- "arrayOk": true,
- "description": "Sets the `link` hover color. It can be a single value, or an array for specifying hover colors for each `link`. If `link.hovercolor` is omitted, then by default, links will become slightly more opaque when hovered over.",
+ "valType": "data_array"
+ },
+ "lowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `low`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "open": {
+ "description": "Sets the open values.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "opensrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `open`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
"editType": "calc",
- "valType": "color"
- },
- "hovercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovercolor`.",
- "editType": "none",
- "valType": "string"
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
},
- "hoverinfo": {
- "description": "Determines which trace information appear when hovering links. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "none",
- "skip"
- ]
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "calc",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "text": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the width of the open/close tick marks relative to the *x* minimal interval.",
+ "dflt": 0.3,
+ "editType": "calc",
+ "max": 0.5,
+ "min": 0,
+ "valType": "number"
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
"editType": "calc",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "font": {
- "color": {
- "arrayOk": true,
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
+ "type": "ohlc",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ },
+ "x": {
+ "description": "Sets the x coordinates. If absent, linear coordinate will be generated.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "xperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "xperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "xperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
+ "dflt": "middle",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
+ },
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ }
+ },
+ "categories": [
+ "cartesian",
+ "svg",
+ "showLegend"
+ ],
+ "meta": {
+ "description": "The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The tip of the lines represent the `low` and `high` values and the horizontal segments represent the `open` and `close` values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red."
+ },
+ "type": "ohlc"
+ },
+ "parcats": {
+ "animatable": false,
+ "attributes": {
+ "arrangement": {
+ "description": "Sets the drag interaction mode for categories and dimensions. If `perpendicular`, the categories can only move along a line perpendicular to the paths. If `freeform`, the categories can freely move on the plane. If `fixed`, the categories and dimensions are stationary.",
+ "dflt": "perpendicular",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "perpendicular",
+ "freeform",
+ "fixed"
+ ]
+ },
+ "bundlecolors": {
+ "description": "Sort paths so that like colors are bundled together within each category.",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "counts": {
+ "arrayOk": true,
+ "description": "The number of observations represented by each state. Defaults to 1 so that each state represents one observation",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "countssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `counts`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "dimensions": {
+ "items": {
+ "dimension": {
+ "categoryarray": {
+ "description": "Sets the order in which categories in this dimension appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.",
"editType": "calc",
- "valType": "color"
+ "valType": "data_array"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "categoryarraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
"editType": "none",
"valType": "string"
},
- "description": "Sets the font used in hover labels.",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "categoryorder": {
+ "description": "Specifies the ordering logic for the categories in the dimension. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.",
+ "dflt": "trace",
"editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "trace",
+ "category ascending",
+ "category descending",
+ "array"
+ ]
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
+ "description": "The dimensions (variables) of the parallel categories diagram.",
+ "displayindex": {
+ "description": "The display index of dimension, from left to right, zero indexed, defaults to dimension index.",
"editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "valType": "integer"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
+ "editType": "calc",
+ "label": {
+ "description": "The shown name of the dimension.",
+ "editType": "calc",
"valType": "string"
},
"role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
+ "ticktext": {
+ "description": "Sets alternative tick labels for the categories in this dimension. Only has an effect if `categoryorder` is set to *array*. Should be an array the same length as `categoryarray` Used with `categoryorder`.",
"editType": "calc",
- "valType": "string"
+ "valType": "data_array"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
"editType": "none",
"valType": "string"
},
- "size": {
- "arrayOk": true,
+ "values": {
+ "description": "Dimension values. `values[n]` represents the category value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated).",
+ "dflt": [],
"editType": "calc",
- "min": 1,
- "valType": "number"
+ "valType": "data_array"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "valuessrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `values`.",
"editType": "none",
"valType": "string"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
+ "visible": {
+ "description": "Shows the dimension when set to `true` (the default). Hides the dimension for `false`.",
+ "dflt": true,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
+ "valType": "boolean"
+ }
+ }
+ },
+ "role": "object"
+ },
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this parcats trace .",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "editType": "calc",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this parcats trace .",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "x": {
+ "description": "Sets the horizontal domain of this parcats trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
+ {
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "y": {
+ "description": "Sets the vertical domain of this parcats trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
"editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
}
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "calc",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
+ ],
+ "valType": "info_array"
+ }
+ },
+ "hoverinfo": {
+ "arrayOk": false,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "plot",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "count",
+ "probability"
+ ],
+ "valType": "flaglist"
+ },
+ "hoveron": {
+ "description": "Sets the hover interaction mode for the parcats diagram. If `category`, hover interaction take place per category. If `color`, hover interactions take place per color per category. If `dimension`, hover interactions take place across all categories per dimension.",
+ "dflt": "category",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "category",
+ "color",
+ "dimension"
+ ]
+ },
+ "hovertemplate": {
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. This value here applies when hovering over dimensions. Note that `*categorycount`, *colorcount* and *bandcolorcount* are only available when `hoveron` contains the *color* flagFinally, the template string has access to variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "labelfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
},
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Variables `source` and `target` are node objects.Finally, the template string has access to variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
+ "description": "Sets the font for the `dimension` labels.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "calc",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
"valType": "string"
},
- "label": {
- "description": "The shown name of the link.",
- "dflt": [],
+ "size": {
"editType": "calc",
- "valType": "data_array"
+ "min": 1,
+ "valType": "number"
},
- "labelsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `label`.",
- "editType": "none",
- "valType": "string"
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
},
- "line": {
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
"color": {
- "arrayOk": true,
- "description": "Sets the color of the `line` around each `link`.",
- "dflt": "#444",
- "editType": "calc",
+ "editType": "style",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
},
- "editType": "calc",
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
"role": "object",
- "width": {
- "arrayOk": true,
- "description": "Sets the width (in px) of the `line` around each `link`.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
"valType": "number"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
"role": "object",
- "source": {
- "description": "An integer number `[0..nodes.length - 1]` that represents the source node.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "sourcesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `source`.",
- "editType": "none",
- "valType": "string"
- },
- "target": {
- "description": "An integer number `[0..nodes.length - 1]` that represents the target node.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "targetsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `target`.",
- "editType": "none",
- "valType": "string"
- },
- "value": {
- "description": "A numeric value representing the flow volume value.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "valuesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `value`.",
- "editType": "none",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
"valType": "string"
}
},
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
- "valType": "string"
+ "min": 0,
+ "valType": "number"
},
- "node": {
- "align": {
- "description": "Sets the alignment method used to position the nodes along the horizontal axis.",
- "dflt": "justify",
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "justify",
- "left",
- "right",
- "center"
- ]
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "color": {
- "arrayOk": true,
- "description": "Sets the `node` color. It can be a single value, or an array for specifying color for each `node`. If `node.color` is omitted, then the default `Plotly` color palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node.",
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.",
+ "dflt": true,
"editType": "calc",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "customdata": {
- "description": "Assigns extra data to each node.",
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.",
+ "dflt": null,
"editType": "calc",
- "valType": "data_array"
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
},
- "description": "The nodes of the Sankey plot.",
- "editType": "calc",
- "groups": {
- "description": "Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified.",
- "dflt": [],
- "dimensions": 2,
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.",
+ "dflt": null,
"editType": "calc",
- "freeLength": true,
"impliedEdits": {
- "x": [],
- "y": []
- },
- "items": {
- "editType": "calc",
- "valType": "number"
+ "cauto": false
},
- "valType": "info_array"
+ "valType": "number"
},
- "hoverinfo": {
- "description": "Determines which trace information appear when hovering nodes. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "none",
- "skip"
- ]
+ "valType": "color"
},
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "calc",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "calc",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
"editType": "calc",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "calc",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
"valType": "string"
},
- "lineposition": {
- "arrayOk": true,
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -60537,56 +58343,32 @@
],
"valType": "flaglist"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
- "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "arrayOk": true,
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"style": {
- "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
"italic"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
"textcase": {
- "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -60595,16 +58377,10 @@
"lower"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -60615,16 +58391,10 @@
"unicase"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -60632,135 +58402,407 @@
"max": 1000,
"min": 1,
"valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
}
},
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "calc",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Variables `sourceLinks` and `targetLinks` are arrays of link objects.Finally, the template string has access to variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "label": {
- "description": "The shown name of the node.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "labelsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `label`.",
- "editType": "none",
- "valType": "string"
- },
- "line": {
- "color": {
- "arrayOk": true,
- "description": "Sets the color of the `line` around each `node`.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
},
- "editType": "calc",
- "role": "object",
- "width": {
- "arrayOk": true,
- "description": "Sets the width (in px) of the `line` around each `node`.",
- "dflt": 0.5,
- "editType": "calc",
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "pad": {
- "arrayOk": false,
- "description": "Sets the padding (in px) between the `nodes`.",
- "dflt": 20,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "thickness": {
- "arrayOk": false,
- "description": "Sets the thickness (in px) of the `nodes`.",
- "dflt": 20,
- "editType": "calc",
- "min": 1,
- "valType": "number"
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
},
- "x": {
- "description": "The normalized horizontal position of the node.",
- "dflt": [],
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
- "valType": "data_array"
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
"valType": "string"
},
- "y": {
- "description": "The normalized vertical position of the node.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
+ "editType": "calc",
+ "hovertemplate": {
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. This value here applies when hovering over lines.Finally, the template string has access to variables `count` and `probability`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "plot",
"valType": "string"
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `line.color` is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "shape": {
+ "description": "Sets the shape of the paths. If `linear`, paths are composed of straight lines. If `hspline`, paths are composed of horizontal curved splines",
+ "dflt": "linear",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "linear",
+ "hspline"
+ ]
+ },
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color` is set to a numerical array.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
}
},
- "orientation": {
- "description": "Sets the orientation of the Sankey diagram.",
- "dflt": "h",
- "editType": "calc",
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "sortpaths": {
+ "description": "Sets the path sorting algorithm. If `forward`, sort paths based on dimension categories from left to right. If `backward`, sort paths based on dimensions categories from right to left.",
+ "dflt": "forward",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "v",
- "h"
+ "forward",
+ "backward"
]
},
- "selectedpoints": {
- "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
- "editType": "calc",
- "valType": "any"
- },
"stream": {
"editType": "calc",
"maxpoints": {
@@ -60780,12 +58822,12 @@
"valType": "string"
}
},
- "textfont": {
+ "tickfont": {
"color": {
"editType": "calc",
"valType": "color"
},
- "description": "Sets the font for node labels",
+ "description": "Sets the font for the `category` labels.",
"editType": "calc",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
@@ -60869,7 +58911,17 @@
"valType": "integer"
}
},
- "type": "sankey",
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
+ "type": "parcats",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -60880,18 +58932,6 @@
"editType": "none",
"valType": "any"
},
- "valueformat": {
- "description": "Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
- "dflt": ".3s",
- "editType": "calc",
- "valType": "string"
- },
- "valuesuffix": {
- "description": "Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
"dflt": true,
@@ -60908,31 +58948,13 @@
"noOpacity"
],
"meta": {
- "description": "Sankey plots for network flow data analysis. The nodes are specified in `nodes` and the links between sources and targets in `links`. The colors are set in `nodes[i].color` and `links[i].color`, otherwise defaults are used."
+ "description": "Parallel categories diagram for multidimensional categorical data."
},
- "type": "sankey"
+ "type": "parcats"
},
- "scatter": {
- "animatable": true,
+ "parcoords": {
+ "animatable": false,
"attributes": {
- "alignmentgroup": {
- "description": "Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "cliponaxis": {
- "description": "Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean"
- },
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
"customdata": {
"description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
"editType": "calc",
@@ -60943,1827 +58965,2754 @@
"editType": "none",
"valType": "string"
},
- "dx": {
- "anim": true,
- "description": "Sets the x coordinate step. See `x0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "dy": {
- "anim": true,
- "description": "Sets the y coordinate step. See `y0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "error_x": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "style",
- "valType": "number"
+ "dimensions": {
+ "items": {
+ "dimension": {
+ "constraintrange": {
+ "description": "The domain range to which the filter on the dimension is constrained. Must be an array of `[fromValue, toValue]` with `fromValue <= toValue`, or if `multiselect` is not disabled, you may give an array of arrays, where each inner array is `[fromValue, toValue]`.",
+ "dimensions": "1-2",
+ "editType": "plot",
+ "freeLength": true,
+ "items": [
+ {
+ "editType": "plot",
+ "valType": "any"
+ },
+ {
+ "editType": "plot",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "description": "The dimensions (variables) of the parallel coordinates chart. 2..60 dimensions are supported.",
+ "editType": "calc",
+ "label": {
+ "description": "The shown name of the dimension.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "multiselect": {
+ "description": "Do we allow multiple selection ranges or just a single range?",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "range": {
+ "description": "The domain range that represents the full, shown axis extent. Defaults to the `values` extent. Must be an array of `[fromValue, toValue]` with finite numbers as elements.",
+ "editType": "plot",
+ "items": [
+ {
+ "editType": "plot",
+ "valType": "number"
+ },
+ {
+ "editType": "plot",
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`.",
+ "editType": "plot",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear.",
+ "editType": "plot",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "values": {
+ "description": "Dimension values. `values[n]` represents the value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated). Each value must be a finite number.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "valuessrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `values`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "visible": {
+ "description": "Shows the dimension when set to `true` (the default). Hides the dimension for `false`.",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ }
}
},
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
- "editType": "none",
- "valType": "string"
- },
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
- "editType": "none",
- "valType": "string"
- },
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "style",
- "valType": "color"
- },
- "copy_ystyle": {
- "editType": "plot",
- "valType": "boolean"
- },
- "editType": "calc",
- "role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "traceref": {
+ "role": "object"
+ },
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this parcoords trace .",
"dflt": 0,
- "editType": "style",
+ "editType": "plot",
"min": 0,
"valType": "integer"
},
- "tracerefminus": {
+ "editType": "plot",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this parcoords trace .",
"dflt": 0,
- "editType": "style",
+ "editType": "plot",
"min": 0,
"valType": "integer"
},
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "percent",
- "constant",
- "sqrt",
- "data"
- ]
- },
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean"
+ "x": {
+ "description": "Sets the horizontal domain of this parcoords trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "plot",
+ "items": [
+ {
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
},
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "y": {
+ "description": "Sets the vertical domain of this parcoords trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
"editType": "plot",
- "min": 0,
- "valType": "number"
+ "items": [
+ {
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
}
},
- "error_y": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "style",
- "valType": "number"
- }
- },
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
- "editType": "none",
- "valType": "string"
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "labelangle": {
+ "description": "Sets the angle of the labels with respect to the horizontal. For example, a `tickangle` of -90 draws the labels vertically. Tilted labels with *labelangle* may be positioned better inside margins when `labelposition` is set to *bottom*.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "angle"
+ },
+ "labelfont": {
+ "color": {
+ "editType": "plot",
+ "valType": "color"
},
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
- "editType": "none",
+ "description": "Sets the font for the `dimension` labels.",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
},
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "style",
- "valType": "color"
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "editType": "calc",
"role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
},
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "style",
- "min": 0,
+ "size": {
+ "editType": "plot",
+ "min": 1,
"valType": "number"
},
- "traceref": {
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer"
- },
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "percent",
- "constant",
- "sqrt",
- "data"
+ "normal",
+ "italic"
]
},
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean"
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "plot",
- "min": 0,
- "valType": "number"
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
- "fill": {
- "description": "Sets the area to fill with a solid color. Defaults to *none* unless this trace is stacked, then it gets *tonexty* (*tonextx*) if `orientation` is *v* (*h*) Use with `fillcolor` if not *none*. *tozerox* and *tozeroy* fill to x=0 and y=0 respectively. *tonextx* and *tonexty* fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like *tozerox* and *tozeroy*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. *tonext* fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like *toself* if there is no trace before it. *tonext* should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.",
- "editType": "calc",
+ "labelside": {
+ "description": "Specifies the location of the `label`. *top* positions labels above, next to the title *bottom* positions labels below the graph Tilted labels with *labelangle* may be positioned better inside margins when `labelposition` is set to *bottom*.",
+ "dflt": "top",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "none",
- "tozeroy",
- "tozerox",
- "tonexty",
- "tonextx",
- "toself",
- "tonext"
+ "top",
+ "bottom"
]
},
- "fillcolor": {
- "anim": true,
- "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.",
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
"editType": "style",
- "valType": "color"
+ "valType": "subplotid"
},
- "fillgradient": {
- "colorscale": {
- "description": "Sets the fill gradient colors as a color scale. The color scale is interpreted as a gradient applied in the direction specified by *orientation*, from the lowest to the highest value of the scatter plot along that axis, or from the center to the most distant point from it, if orientation is *radial*.",
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "Sets this legend group's title font.",
"editType": "style",
- "valType": "colorscale"
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
},
- "description": "Sets a fill gradient. If not specified, the fillcolor is used instead.",
- "editType": "calc",
"role": "object",
- "start": {
- "description": "Sets the gradient start value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is *horizontal*, the gradient will be horizontal and start from the x-position given by start. If omitted, the gradient starts at the lowest value of the trace along the respective axis. Ignored if orientation is *radial*.",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": false,
"editType": "calc",
- "valType": "number"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "stop": {
- "description": "Sets the gradient end value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is *horizontal*, the gradient will be horizontal and end at the x-position given by end. If omitted, the gradient ends at the highest value of the trace along the respective axis. Ignored if orientation is *radial*.",
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.",
+ "dflt": null,
"editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
"valType": "number"
},
- "type": {
- "description": "Sets the type/orientation of the color gradient for the fill. Defaults to *none*.",
- "dflt": "none",
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.",
+ "dflt": null,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "radial",
- "horizontal",
- "vertical",
- "none"
- ]
- }
- },
- "fillpattern": {
- "bgcolor": {
- "arrayOk": true,
- "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
- "editType": "style",
- "valType": "color"
+ "impliedEdits": {},
+ "valType": "number"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
},
- "description": "Sets the pattern within the marker.",
- "editType": "style",
- "fgcolor": {
+ "color": {
"arrayOk": true,
- "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
- "editType": "style",
+ "description": "Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.",
+ "editType": "calc",
"valType": "color"
},
- "fgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
- "editType": "none",
- "valType": "string"
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
},
- "fgopacity": {
- "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "fillmode": {
- "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
- "dflt": "replace",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "replace",
- "overlay"
- ]
- },
- "role": "object",
- "shape": {
- "arrayOk": true,
- "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
- "dflt": "",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "",
- "/",
- "\\",
- "x",
- "-",
- "|",
- "+",
- "."
- ]
- },
- "shapesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
- "dflt": 8,
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "solidity": {
- "arrayOk": true,
- "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
- "dflt": 0.3,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "groupnorm": {
- "description": "Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Sets the normalization for the sum of this `stackgroup`. With *fraction*, the value of each trace at each location is divided by the sum of all trace values at that location. *percent* is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.",
- "dflt": "",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "",
- "fraction",
- "percent"
- ]
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
},
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
},
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
},
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "h",
+ "v"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
},
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
- },
- "hoveron": {
- "description": "Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is *toself* or *tonext* and there are no markers or text, then the default is *fills*, otherwise it is *points*.",
- "editType": "style",
- "flags": [
- "points",
- "fills"
- ],
- "valType": "flaglist"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "anim": true,
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "style",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
},
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "style",
- "valType": "string"
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
},
- "size": {
- "editType": "style",
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "colorbars",
"min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "auto",
+ "linear",
+ "array"
]
},
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "style",
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "outside",
+ "inside",
+ ""
]
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "left",
+ "center",
+ "right"
]
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "line": {
- "backoff": {
- "arrayOk": true,
- "description": "Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With *auto* the lines would trim before markers if `marker.angleref` is set to *previous*.",
- "dflt": "auto",
- "editType": "plot",
- "min": 0,
- "valType": "number"
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
},
- "backoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": [
+ [
+ 0,
+ "#440154"
+ ],
+ [
+ 0.06274509803921569,
+ "#48186a"
+ ],
+ [
+ 0.12549019607843137,
+ "#472d7b"
+ ],
+ [
+ 0.18823529411764706,
+ "#424086"
+ ],
+ [
+ 0.25098039215686274,
+ "#3b528b"
+ ],
+ [
+ 0.3137254901960784,
+ "#33638d"
+ ],
+ [
+ 0.3764705882352941,
+ "#2c728e"
+ ],
+ [
+ 0.4392156862745098,
+ "#26828e"
+ ],
+ [
+ 0.5019607843137255,
+ "#21918c"
+ ],
+ [
+ 0.5647058823529412,
+ "#1fa088"
+ ],
+ [
+ 0.6274509803921569,
+ "#28ae80"
+ ],
+ [
+ 0.6901960784313725,
+ "#3fbc73"
+ ],
+ [
+ 0.7529411764705882,
+ "#5ec962"
+ ],
+ [
+ 0.8156862745098039,
+ "#84d44b"
+ ],
+ [
+ 0.8784313725490196,
+ "#addc30"
+ ],
+ [
+ 0.9411764705882353,
+ "#d8e219"
+ ],
+ [
+ 1,
+ "#fde725"
+ ]
+ ],
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
"valType": "string"
},
+ "editType": "calc",
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `line.color` is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color` is set to a numerical array.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ }
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "rangefont": {
"color": {
- "anim": true,
- "description": "Sets the line color.",
- "editType": "style",
+ "editType": "plot",
"valType": "color"
},
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
- "dflt": "solid",
- "editType": "style",
- "valType": "string",
+ "description": "Sets the font for the `dimension` range values.",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
"values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
+ "normal",
+ "italic"
]
},
- "editType": "plot",
- "role": "object",
- "shape": {
- "description": "Determines the line shape. With *spline* the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.",
- "dflt": "linear",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "plot",
"valType": "enumerated",
"values": [
- "linear",
- "spline",
- "hv",
- "vh",
- "hvh",
- "vhv"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "simplify": {
- "description": "Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.",
- "dflt": true,
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "plot",
- "valType": "boolean"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "smoothing": {
- "description": "Has an effect only if `shape` is set to *spline* Sets the amount of smoothing. *0* corresponds to no smoothing (equivalent to a *linear* shape).",
- "dflt": 1,
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "plot",
- "max": 1.3,
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
"min": 0,
"valType": "number"
},
- "width": {
- "anim": true,
- "description": "Sets the line width (in px).",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number"
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
}
},
- "marker": {
- "angle": {
- "anim": false,
- "arrayOk": true,
- "description": "Sets the marker angle in respect to `angleref`.",
- "dflt": 0,
+ "tickfont": {
+ "color": {
"editType": "plot",
- "valType": "angle"
+ "valType": "color"
},
- "angleref": {
- "anim": false,
- "description": "Sets the reference for marker angle. With *previous*, angle 0 points along the line from the previous point to this one. With *up*, angle 0 points toward the top of the screen.",
- "dflt": "up",
+ "description": "Sets the font for the `dimension` tick values.",
+ "editType": "plot",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "auto",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "plot",
"valType": "enumerated",
"values": [
- "previous",
- "up"
+ "normal",
+ "italic"
]
},
- "anglesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
- "editType": "none",
- "valType": "string"
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
- "dflt": null,
+ "role": "object"
+ },
+ "type": "parcoords",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "unselected": {
+ "editType": "plot",
+ "line": {
+ "color": {
+ "description": "Sets the base color of unselected lines. in connection with `unselected.line.opacity`.",
+ "dflt": "#7f7f7f",
+ "editType": "plot",
+ "valType": "color"
+ },
"editType": "plot",
- "impliedEdits": {
- "cauto": false
+ "opacity": {
+ "description": "Sets the opacity of unselected lines. The default *auto* decreases the opacity smoothly as the number of lines increases. Use *1* to achieve exact `unselected.line.color`.",
+ "dflt": "auto",
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "valType": "number"
+ "role": "object"
},
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
- "dflt": null,
+ "role": "object"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ }
+ },
+ "categories": [
+ "gl",
+ "regl",
+ "noOpacity",
+ "noHover"
+ ],
+ "meta": {
+ "description": "Parallel coordinates for multidimensional exploratory data analysis. The samples are specified in `dimensions`. The colors are set in `line.color`."
+ },
+ "type": "parcoords"
+ },
+ "pie": {
+ "animatable": false,
+ "attributes": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of `title.text`. Note that value of `title` is no longer a simple *string* but a set of sub-attributes.",
+ "dflt": "",
"editType": "calc",
- "impliedEdits": {},
- "valType": "number"
+ "valType": "string"
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
- "dflt": null,
+ "titlefont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of `title.font`.",
"editType": "plot",
- "impliedEdits": {
- "cauto": false
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "valType": "number"
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
},
- "color": {
- "anim": true,
- "arrayOk": true,
- "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
- "editType": "style",
- "valType": "color"
+ "titleposition": {
+ "description": "Deprecated in favor of `title.position`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle center",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ]
+ }
+ },
+ "automargin": {
+ "description": "Determines whether outside text labels can push the margins.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "direction": {
+ "description": "Specifies the direction at which succeeding sectors follow one another.",
+ "dflt": "counterclockwise",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "clockwise",
+ "counterclockwise"
+ ]
+ },
+ "dlabel": {
+ "description": "Sets the label step. See `label0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this pie trace .",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
+ "editType": "calc",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this pie trace .",
+ "dflt": 0,
"editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "min": 0,
+ "valType": "integer"
},
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
+ "x": {
+ "description": "Sets the horizontal domain of this pie trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "titlefont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "y": {
+ "description": "Sets the vertical domain of this pie trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
}
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
+ ],
+ "valType": "info_array"
+ }
+ },
+ "hole": {
+ "description": "Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "value",
+ "percent",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
"valType": "color"
},
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
},
- "editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
},
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
},
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
},
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
"valType": "number"
},
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "integer"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "h",
- "v"
+ "normal",
+ "italic"
]
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean"
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
},
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
},
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `percent` and `text`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace's sectors. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "insidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used for `textinfo` lying inside the sector.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "insidetextorientation": {
+ "description": "Controls the orientation of the text inside chart sectors. When set to *auto*, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The *horizontal* option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The *radial* option orients text along the radius of the sector. The *tangential* option orients text perpendicular to the radius of the sector.",
+ "dflt": "auto",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "horizontal",
+ "radial",
+ "tangential",
+ "auto"
+ ]
+ },
+ "label0": {
+ "description": "Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "labels": {
+ "description": "Sets the sector labels. If `labels` entries are duplicated, we sum associated `values` or simply count occurrences if `values` is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "labelssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "italic"
]
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "marker": {
+ "colors": {
+ "description": "Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "colorssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "line": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the color of the line enclosing each sector.",
+ "dflt": "#444",
+ "editType": "style",
+ "valType": "color"
},
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the line enclosing each sector.",
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "pattern": {
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
+ "editType": "style",
"valType": "color"
},
- "tickfont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
"valType": "string"
},
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
+ "description": "Sets the pattern within the marker.",
+ "editType": "style",
+ "fgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
+ "editType": "style",
+ "valType": "color"
},
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 1,
- "valType": "integer"
+ "fgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
+ "editType": "none",
+ "valType": "string"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
+ "fgopacity": {
+ "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
+ "editType": "style",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
- "impliedEdits": {},
+ "fillmode": {
+ "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
+ "dflt": "replace",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "auto",
- "linear",
- "array"
+ "replace",
+ "overlay"
]
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "role": "object",
+ "shape": {
+ "arrayOk": true,
+ "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
"dflt": "",
- "editType": "colorbars",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "",
+ "/",
+ "\\",
+ "x",
+ "-",
+ "|",
+ "+",
+ "."
]
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "shapesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
"editType": "none",
"valType": "string"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
- "valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
+ "dflt": 8,
+ "editType": "style",
"min": 0,
"valType": "number"
},
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
- },
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "top",
- "middle",
- "bottom"
- ]
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
+ "solidity": {
+ "arrayOk": true,
+ "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
+ "dflt": 0.3,
+ "editType": "style",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
+ "soliditysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
+ "role": "object"
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "outsidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
},
"colorsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
"valType": "string"
},
- "editType": "calc",
- "gradient": {
- "color": {
- "arrayOk": true,
- "description": "Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.",
- "editType": "calc",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "role": "object",
- "type": {
- "arrayOk": true,
- "description": "Sets the type of gradient used to fill the markers",
- "dflt": "none",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "radial",
- "horizontal",
- "vertical",
- "none"
- ]
- },
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "color": {
- "anim": true,
- "arrayOk": true,
- "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
- "editType": "style",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "role": "object",
- "width": {
- "anim": true,
- "arrayOk": true,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "maxdisplayed": {
- "description": "Sets a maximum number of points to be drawn on the graph. *0* corresponds to no limit.",
- "dflt": 0,
+ "description": "Sets the font used for `textinfo` lying outside the sector.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "plot",
- "min": 0,
- "valType": "number"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "opacity": {
- "anim": true,
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
"arrayOk": true,
- "description": "Sets the marker opacity.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
"editType": "none",
"valType": "string"
},
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
- "dflt": false,
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
"editType": "plot",
- "valType": "boolean"
+ "valType": "string"
},
- "role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
},
"size": {
- "anim": true,
"arrayOk": true,
- "description": "Sets the marker size (in px).",
- "dflt": 6,
- "editType": "calc",
- "min": 0,
+ "editType": "plot",
+ "min": 1,
"valType": "number"
},
- "sizemin": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "sizemode": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
- "dflt": "diameter",
- "editType": "calc",
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "diameter",
- "area"
+ "normal",
+ "italic"
]
},
- "sizeref": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
- "dflt": 1,
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "pull": {
+ "arrayOk": true,
+ "description": "Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "pullsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `pull`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "rotation": {
+ "description": "Instead of the first slice starting at 12 o'clock, rotate to some other angle.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "angle"
+ },
+ "scalegroup": {
+ "description": "If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "sort": {
+ "description": "Determines whether or not the sectors are reordered from largest to smallest.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
"editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "text": {
+ "description": "Sets text elements associated with each sector. If trace `textinfo` contains a *text* flag, these elements will be seen on the chart. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "editType": "plot",
+ "valType": "data_array"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used for `textinfo`.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
"valType": "number"
},
"sizesrc": {
@@ -62771,844 +61720,295 @@
"editType": "none",
"valType": "string"
},
- "standoff": {
- "anim": true,
+ "style": {
"arrayOk": true,
- "description": "Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.",
- "dflt": 0,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "plot",
- "min": 0,
- "valType": "number"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
},
- "standoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `standoff`.",
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
"editType": "none",
"valType": "string"
},
- "symbol": {
+ "textcase": {
"arrayOk": true,
- "description": "Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name.",
- "dflt": "circle",
- "editType": "style",
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- 0,
- "0",
- "circle",
- 100,
- "100",
- "circle-open",
- 200,
- "200",
- "circle-dot",
- 300,
- "300",
- "circle-open-dot",
- 1,
- "1",
- "square",
- 101,
- "101",
- "square-open",
- 201,
- "201",
- "square-dot",
- 301,
- "301",
- "square-open-dot",
- 2,
- "2",
- "diamond",
- 102,
- "102",
- "diamond-open",
- 202,
- "202",
- "diamond-dot",
- 302,
- "302",
- "diamond-open-dot",
- 3,
- "3",
- "cross",
- 103,
- "103",
- "cross-open",
- 203,
- "203",
- "cross-dot",
- 303,
- "303",
- "cross-open-dot",
- 4,
- "4",
- "x",
- 104,
- "104",
- "x-open",
- 204,
- "204",
- "x-dot",
- 304,
- "304",
- "x-open-dot",
- 5,
- "5",
- "triangle-up",
- 105,
- "105",
- "triangle-up-open",
- 205,
- "205",
- "triangle-up-dot",
- 305,
- "305",
- "triangle-up-open-dot",
- 6,
- "6",
- "triangle-down",
- 106,
- "106",
- "triangle-down-open",
- 206,
- "206",
- "triangle-down-dot",
- 306,
- "306",
- "triangle-down-open-dot",
- 7,
- "7",
- "triangle-left",
- 107,
- "107",
- "triangle-left-open",
- 207,
- "207",
- "triangle-left-dot",
- 307,
- "307",
- "triangle-left-open-dot",
- 8,
- "8",
- "triangle-right",
- 108,
- "108",
- "triangle-right-open",
- 208,
- "208",
- "triangle-right-dot",
- 308,
- "308",
- "triangle-right-open-dot",
- 9,
- "9",
- "triangle-ne",
- 109,
- "109",
- "triangle-ne-open",
- 209,
- "209",
- "triangle-ne-dot",
- 309,
- "309",
- "triangle-ne-open-dot",
- 10,
- "10",
- "triangle-se",
- 110,
- "110",
- "triangle-se-open",
- 210,
- "210",
- "triangle-se-dot",
- 310,
- "310",
- "triangle-se-open-dot",
- 11,
- "11",
- "triangle-sw",
- 111,
- "111",
- "triangle-sw-open",
- 211,
- "211",
- "triangle-sw-dot",
- 311,
- "311",
- "triangle-sw-open-dot",
- 12,
- "12",
- "triangle-nw",
- 112,
- "112",
- "triangle-nw-open",
- 212,
- "212",
- "triangle-nw-dot",
- 312,
- "312",
- "triangle-nw-open-dot",
- 13,
- "13",
- "pentagon",
- 113,
- "113",
- "pentagon-open",
- 213,
- "213",
- "pentagon-dot",
- 313,
- "313",
- "pentagon-open-dot",
- 14,
- "14",
- "hexagon",
- 114,
- "114",
- "hexagon-open",
- 214,
- "214",
- "hexagon-dot",
- 314,
- "314",
- "hexagon-open-dot",
- 15,
- "15",
- "hexagon2",
- 115,
- "115",
- "hexagon2-open",
- 215,
- "215",
- "hexagon2-dot",
- 315,
- "315",
- "hexagon2-open-dot",
- 16,
- "16",
- "octagon",
- 116,
- "116",
- "octagon-open",
- 216,
- "216",
- "octagon-dot",
- 316,
- "316",
- "octagon-open-dot",
- 17,
- "17",
- "star",
- 117,
- "117",
- "star-open",
- 217,
- "217",
- "star-dot",
- 317,
- "317",
- "star-open-dot",
- 18,
- "18",
- "hexagram",
- 118,
- "118",
- "hexagram-open",
- 218,
- "218",
- "hexagram-dot",
- 318,
- "318",
- "hexagram-open-dot",
- 19,
- "19",
- "star-triangle-up",
- 119,
- "119",
- "star-triangle-up-open",
- 219,
- "219",
- "star-triangle-up-dot",
- 319,
- "319",
- "star-triangle-up-open-dot",
- 20,
- "20",
- "star-triangle-down",
- 120,
- "120",
- "star-triangle-down-open",
- 220,
- "220",
- "star-triangle-down-dot",
- 320,
- "320",
- "star-triangle-down-open-dot",
- 21,
- "21",
- "star-square",
- 121,
- "121",
- "star-square-open",
- 221,
- "221",
- "star-square-dot",
- 321,
- "321",
- "star-square-open-dot",
- 22,
- "22",
- "star-diamond",
- 122,
- "122",
- "star-diamond-open",
- 222,
- "222",
- "star-diamond-dot",
- 322,
- "322",
- "star-diamond-open-dot",
- 23,
- "23",
- "diamond-tall",
- 123,
- "123",
- "diamond-tall-open",
- 223,
- "223",
- "diamond-tall-dot",
- 323,
- "323",
- "diamond-tall-open-dot",
- 24,
- "24",
- "diamond-wide",
- 124,
- "124",
- "diamond-wide-open",
- 224,
- "224",
- "diamond-wide-dot",
- 324,
- "324",
- "diamond-wide-open-dot",
- 25,
- "25",
- "hourglass",
- 125,
- "125",
- "hourglass-open",
- 26,
- "26",
- "bowtie",
- 126,
- "126",
- "bowtie-open",
- 27,
- "27",
- "circle-cross",
- 127,
- "127",
- "circle-cross-open",
- 28,
- "28",
- "circle-x",
- 128,
- "128",
- "circle-x-open",
- 29,
- "29",
- "square-cross",
- 129,
- "129",
- "square-cross-open",
- 30,
- "30",
- "square-x",
- 130,
- "130",
- "square-x-open",
- 31,
- "31",
- "diamond-cross",
- 131,
- "131",
- "diamond-cross-open",
- 32,
- "32",
- "diamond-x",
- 132,
- "132",
- "diamond-x-open",
- 33,
- "33",
- "cross-thin",
- 133,
- "133",
- "cross-thin-open",
- 34,
- "34",
- "x-thin",
- 134,
- "134",
- "x-thin-open",
- 35,
- "35",
- "asterisk",
- 135,
- "135",
- "asterisk-open",
- 36,
- "36",
- "hash",
- 136,
- "136",
- "hash-open",
- 236,
- "236",
- "hash-dot",
- 336,
- "336",
- "hash-open-dot",
- 37,
- "37",
- "y-up",
- 137,
- "137",
- "y-up-open",
- 38,
- "38",
- "y-down",
- 138,
- "138",
- "y-down-open",
- 39,
- "39",
- "y-left",
- 139,
- "139",
- "y-left-open",
- 40,
- "40",
- "y-right",
- 140,
- "140",
- "y-right-open",
- 41,
- "41",
- "line-ew",
- 141,
- "141",
- "line-ew-open",
- 42,
- "42",
- "line-ns",
- 142,
- "142",
- "line-ns-open",
- 43,
- "43",
- "line-ne",
- 143,
- "143",
- "line-ne-open",
- 44,
- "44",
- "line-nw",
- 144,
- "144",
- "line-nw-open",
- 45,
- "45",
- "arrow-up",
- 145,
- "145",
- "arrow-up-open",
- 46,
- "46",
- "arrow-down",
- 146,
- "146",
- "arrow-down-open",
- 47,
- "47",
- "arrow-left",
- 147,
- "147",
- "arrow-left-open",
- 48,
- "48",
- "arrow-right",
- 148,
- "148",
- "arrow-right-open",
- 49,
- "49",
- "arrow-bar-up",
- 149,
- "149",
- "arrow-bar-up-open",
- 50,
- "50",
- "arrow-bar-down",
- 150,
- "150",
- "arrow-bar-down-open",
- 51,
- "51",
- "arrow-bar-left",
- 151,
- "151",
- "arrow-bar-left-open",
- 52,
- "52",
- "arrow-bar-right",
- 152,
- "152",
- "arrow-bar-right-open",
- 53,
- "53",
- "arrow",
- 153,
- "153",
- "arrow-open",
- 54,
- "54",
- "arrow-wide",
- 154,
- "154",
- "arrow-wide-open"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
"editType": "none",
"valType": "string"
}
},
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "mode": {
- "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.",
+ "textinfo": {
+ "description": "Determines which trace information appear on the graph.",
"editType": "calc",
"extras": [
"none"
],
"flags": [
- "lines",
- "markers",
- "text"
+ "label",
+ "text",
+ "value",
+ "percent"
],
"valType": "flaglist"
},
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
+ "textposition": {
+ "arrayOk": true,
+ "description": "Specifies the location of the `textinfo`.",
+ "dflt": "auto",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "outside",
+ "auto",
+ "none"
+ ]
+ },
+ "textpositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "editType": "none",
"valType": "string"
},
- "offsetgroup": {
- "description": "Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.",
- "dflt": "",
- "editType": "calc",
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
"valType": "string"
},
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `label`, `color`, `value`, `percent` and `text`.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
},
- "orientation": {
- "description": "Only relevant in the following cases: 1. when `scattermode` is set to *group*. 2. when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Sets the stacking direction. With *v* (*h*), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "v",
- "h"
- ]
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "editType": "none",
+ "valType": "string"
},
- "selected": {
- "editType": "style",
- "marker": {
+ "title": {
+ "editType": "plot",
+ "font": {
"color": {
- "description": "Sets the marker color of selected points.",
- "editType": "style",
+ "arrayOk": true,
+ "editType": "plot",
"valType": "color"
},
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "role": "object",
- "size": {
- "description": "Sets the marker size of selected points.",
- "editType": "style",
- "min": 0,
+ "description": "Sets the font used for `title`. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "plot",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
"valType": "number"
- }
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of selected points.",
- "editType": "style",
- "valType": "color"
},
- "editType": "style",
- "role": "object"
- }
- },
- "selectedpoints": {
- "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
- "editType": "calc",
- "valType": "any"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean"
- },
- "stackgaps": {
- "description": "Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Determines how we handle locations at which other traces in this group have data but this one does not. With *infer zero* we insert a zero at these locations. With *interpolate* we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.",
- "dflt": "infer zero",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "infer zero",
- "interpolate"
- ]
- },
- "stackgroup": {
- "description": "Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is *h*). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using *tonexty* (*tonextx*) if `orientation` is *h* (*v*) and sets the default `mode` to *lines* irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "text": {
- "arrayOk": true,
- "description": "Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "style",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the text font.",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
+ "position": {
+ "description": "Specifies the location of the `title`. Note that the title's position used to be set by the now deprecated `titleposition` attribute.",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "top left",
+ "top center",
+ "top right",
+ "middle center",
+ "bottom left",
+ "bottom center",
+ "bottom right"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the chart. If it is empty, no title is displayed. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "dflt": "",
+ "editType": "plot",
"valType": "string"
}
},
- "textposition": {
- "arrayOk": true,
- "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
- "dflt": "middle center",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "top left",
- "top center",
- "top right",
- "middle left",
- "middle center",
- "middle right",
- "bottom left",
- "bottom center",
- "bottom right"
- ]
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
- },
"transforms": {
"items": {
"transform": {
@@ -63619,9 +62019,8 @@
},
"role": "object"
},
- "type": "scatter",
+ "type": "pie",
"uid": {
- "anim": true,
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string"
@@ -63631,40 +62030,15 @@
"editType": "none",
"valType": "any"
},
- "unselected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color"
- },
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of unselected points, applied only when a selection exists.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- }
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color"
- },
- "editType": "style",
- "role": "object"
- }
+ "values": {
+ "description": "Sets the values of the sectors. If omitted, we count occurrences of each label.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "valuessrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `values`.",
+ "editType": "none",
+ "valType": "string"
},
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
@@ -63676,208 +62050,44 @@
false,
"legendonly"
]
+ }
+ },
+ "categories": [
+ "pie-like",
+ "pie",
+ "showLegend"
+ ],
+ "layoutAttributes": {
+ "extendpiecolors": {
+ "description": "If `true`, the pie slice colors (whether given by `piecolorway` or inherited from `colorway`) will be extended to three times its original length by first repeating every color 20% lighter then each color 20% darker. This is intended to reduce the likelihood of reusing the same color when you have many slices, but you can set `false` to disable. Colors provided in the trace, using `marker.colors`, are never extended.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
},
- "x": {
- "anim": true,
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "x0": {
- "anim": true,
- "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any"
- },
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
+ "hiddenlabels": {
+ "description": "hiddenlabels is the funnelarea & pie chart analog of visible:'legendonly' but it can contain many labels, and can simultaneously hide slices from several pies/funnelarea charts",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
+ "valType": "data_array"
},
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
+ "hiddenlabelssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hiddenlabels`.",
"editType": "none",
"valType": "string"
},
- "xperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "valType": "any"
- },
- "xperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "xperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
- "dflt": "middle",
+ "piecolorway": {
+ "description": "Sets the default pie slice colors. Defaults to the main `colorway` used for trace colors. If you specify a new list here it can still be extended with lighter and darker colors, see `extendpiecolors`.",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "y": {
- "anim": true,
- "description": "Sets the y coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "y0": {
- "anim": true,
- "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any"
- },
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "ycalendar": {
- "description": "Sets the calendar system to use with `y` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "yperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "valType": "any"
- },
- "yperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "yperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
- "dflt": "middle",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
- }
- },
- "categories": [
- "cartesian",
- "svg",
- "symbols",
- "errorBarsOK",
- "showLegend",
- "scatter-like",
- "zoomScale"
- ],
- "layoutAttributes": {
- "scattergap": {
- "description": "Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to `bargap`.",
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "scattermode": {
- "description": "Determines how scatter points at the same location coordinate are displayed on the graph. With *group*, the scatter points are plotted next to one another centered around the shared location. With *overlay*, the scatter points are plotted over one another, you might need to reduce *opacity* to see multiple scatter points.",
- "dflt": "overlay",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "group",
- "overlay"
- ]
+ "valType": "colorlist"
}
},
"meta": {
- "description": "The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in `x` and `y`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to numerical arrays."
+ "description": "A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`"
},
- "type": "scatter"
+ "type": "pie"
},
- "scatter3d": {
+ "pointcloud": {
"animatable": false,
"attributes": {
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
"customdata": {
"description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
"editType": "calc",
@@ -63888,307 +62098,11 @@
"editType": "none",
"valType": "string"
},
- "error_x": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "calc",
- "valType": "number"
- }
- },
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
- "editType": "none",
- "valType": "string"
- },
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
- "editType": "none",
- "valType": "string"
- },
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "calc",
- "valType": "color"
- },
- "copy_zstyle": {
- "editType": "calc",
- "valType": "boolean"
- },
- "editType": "calc",
- "role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "traceref": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "percent",
- "constant",
- "sqrt",
- "data"
- ]
- },
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- }
- },
- "error_y": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "calc",
- "valType": "number"
- }
- },
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
- "editType": "none",
- "valType": "string"
- },
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
- "editType": "none",
- "valType": "string"
- },
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "calc",
- "valType": "color"
- },
- "copy_zstyle": {
- "editType": "calc",
- "valType": "boolean"
- },
- "editType": "calc",
- "role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "traceref": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "percent",
- "constant",
- "sqrt",
- "data"
- ]
- },
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- }
- },
- "error_z": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "calc",
- "valType": "number"
- }
- },
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
- "editType": "none",
- "valType": "string"
- },
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
- "editType": "none",
- "valType": "string"
- },
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "traceref": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "percent",
- "constant",
- "sqrt",
- "data"
- ]
- },
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- }
- },
"hoverinfo": {
"arrayOk": true,
"description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
"dflt": "all",
- "editType": "calc",
+ "editType": "none",
"extras": [
"all",
"none",
@@ -64407,37 +62321,23 @@
},
"role": "object"
},
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
"editType": "calc",
- "valType": "string"
+ "valType": "data_array"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
"editType": "none",
"valType": "string"
},
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "indices": {
+ "description": "A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call.",
"editType": "calc",
"valType": "data_array"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "indicessrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `indices`.",
"editType": "none",
"valType": "string"
},
@@ -64564,369 +62464,825 @@
"min": 0,
"valType": "number"
},
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
+ "marker": {
+ "blend": {
+ "description": "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.",
+ "dflt": null,
"editType": "calc",
- "impliedEdits": {},
"valType": "boolean"
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.",
- "dflt": true,
+ "border": {
+ "arearatio": {
+ "description": "Specifies what fraction of the marker area is covered with the border.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": false,
+ "description": "Sets the stroke color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.",
+ "editType": "calc",
+ "valType": "color"
+ },
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "role": "object"
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.",
- "dflt": null,
+ "color": {
+ "arrayOk": false,
+ "description": "Sets the marker fill color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.",
"editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
+ "valType": "color"
},
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.",
- "dflt": null,
+ "editType": "calc",
+ "opacity": {
+ "arrayOk": false,
+ "description": "Sets the marker opacity. The default value is `1` (fully opaque). If the markers are not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning. Opacity fades the color even if `blend` is left on `false` even if there is no translucency effect in that case.",
+ "dflt": 1,
"editType": "calc",
- "impliedEdits": {},
+ "max": 1,
+ "min": 0,
"valType": "number"
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.",
- "dflt": null,
+ "role": "object",
+ "sizemax": {
+ "description": "Sets the maximum size (in px) of the rendered marker points. Effective when the `pointcloud` shows only few points.",
+ "dflt": 20,
"editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
+ "min": 0.1,
"valType": "number"
},
- "color": {
- "arrayOk": true,
- "description": "Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.",
+ "sizemin": {
+ "description": "Sets the minimum size (in px) of the rendered marker points, effective when the `pointcloud` shows a million or more points.",
+ "dflt": 0.5,
"editType": "calc",
- "valType": "color"
+ "max": 2,
+ "min": 0.1,
+ "valType": "number"
+ }
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
"editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "text": {
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "type": "pointcloud",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ },
+ "x": {
+ "description": "Sets the x coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "xbounds": {
+ "description": "Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "xboundssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `xbounds`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "xy": {
+ "description": "Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "xysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `xy`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "y": {
+ "description": "Sets the y coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "ybounds": {
+ "description": "Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "yboundssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ybounds`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "categories": [
+ "gl",
+ "gl2d",
+ "showLegend"
+ ],
+ "meta": {
+ "description": "*pointcloud* trace is deprecated! Please consider switching to the *scattergl* trace type. The data visualized as a point cloud set in `x` and `y` using the WebGl plotting engine."
+ },
+ "type": "pointcloud"
+ },
+ "sankey": {
+ "animatable": false,
+ "attributes": {
+ "arrangement": {
+ "description": "If value is `snap` (the default), the node arrangement is assisted by automatic snapping of elements to preserve space between nodes specified via `nodepad`. If value is `perpendicular`, the nodes can only move along a line perpendicular to the flow. If value is `freeform`, the nodes can freely move on the plane. If value is `fixed`, the nodes are stationary.",
+ "dflt": "snap",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "snap",
+ "perpendicular",
+ "freeform",
+ "fixed"
+ ]
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this sankey trace .",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
},
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "calc",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this sankey trace .",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "x": {
+ "description": "Sets the horizontal domain of this sankey trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
"editType": "calc",
- "valType": "string"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "titlefont": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
+ {
"editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "y": {
+ "description": "Sets the vertical domain of this sankey trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
+ {
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
+ "max": 1,
+ "min": 0,
+ "valType": "number"
}
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
+ ],
+ "valType": "info_array"
+ }
+ },
+ "hoverinfo": {
+ "arrayOk": false,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively.",
+ "dflt": "all",
+ "editType": "calc",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [],
+ "valType": "flaglist"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "font": {
+ "color": {
+ "arrayOk": true,
"editType": "calc",
"valType": "color"
},
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
+ "description": "Sets the font used in hover labels.",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "calc",
- "min": 0,
- "valType": "number"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
},
- "editType": "calc",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "calc",
- "valType": "any"
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
},
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
"editType": "calc",
- "min": 0,
- "valType": "number"
+ "valType": "string"
},
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
},
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
+ "size": {
+ "arrayOk": true,
"editType": "calc",
- "min": 0,
+ "min": 1,
"valType": "number"
},
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "calc",
"valType": "enumerated",
"values": [
- "h",
- "v"
+ "normal",
+ "italic"
]
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "calc",
- "min": 0,
- "valType": "number"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
},
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "calc",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
},
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "calc",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "italic"
]
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "calc",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "link": {
+ "arrowlen": {
+ "description": "Sets the length (in px) of the links arrow, if 0 no arrow will be drawn.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "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.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorscales": {
+ "items": {
+ "concentrationscales": {
+ "cmax": {
+ "description": "Sets the upper bound of the color domain.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `cmin` and `cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": [
+ [
+ 0,
+ "white"
+ ],
+ [
+ 1,
+ "black"
+ ]
+ ],
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "editType": "calc",
+ "label": {
+ "description": "The label of the links to color based on their concentration within a flow.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "customdata": {
+ "description": "Assigns extra data to each link.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "The links of the Sankey plot.",
+ "editType": "calc",
+ "hovercolor": {
+ "arrayOk": true,
+ "description": "Sets the `link` hover color. It can be a single value, or an array for specifying hover colors for each `link`. If `link.hovercolor` is omitted, then by default, links will become slightly more opaque when hovered over.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "hovercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverinfo": {
+ "description": "Determines which trace information appear when hovering links. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "none",
+ "skip"
+ ]
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
"editType": "calc",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "left",
+ "right",
+ "auto"
]
},
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
"editType": "calc",
- "valType": "angle"
+ "valType": "color"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
"editType": "calc",
"valType": "color"
},
- "tickfont": {
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "font": {
"color": {
+ "arrayOk": true,
"editType": "calc",
"valType": "color"
},
- "description": "Sets the color bar's tick label font",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
"editType": "calc",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string"
},
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
"lineposition": {
+ "arrayOk": true,
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
"editType": "calc",
@@ -64940,19 +63296,37 @@
],
"valType": "flaglist"
},
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
"shadow": {
+ "arrayOk": true,
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
"editType": "calc",
"valType": "string"
},
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
"size": {
+ "arrayOk": true,
"editType": "calc",
"min": 1,
"valType": "number"
},
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
"editType": "calc",
@@ -64962,7 +63336,13 @@
"italic"
]
},
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
"textcase": {
+ "arrayOk": true,
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
"editType": "calc",
@@ -64974,7 +63354,13 @@
"lower"
]
},
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
"editType": "calc",
@@ -64988,7 +63374,13 @@
"unicase"
]
},
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
"editType": "calc",
@@ -64999,990 +63391,1606 @@
"max": 1000,
"min": 1,
"valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
"editType": "calc",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
"valType": "string"
},
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "valType": "any"
- },
- {
- "editType": "calc",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "calc",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "calc",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Variables `source` and `target` are node objects.Finally, the template string has access to variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "label": {
+ "description": "The shown name of the link.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "labelsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `label`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "line": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the color of the `line` around each `link`.",
+ "dflt": "#444",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
+ "valType": "color"
},
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "calc",
- "min": 1,
- "valType": "integer"
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the `line` around each `link`.",
+ "dflt": 0,
"editType": "calc",
"min": 0,
"valType": "number"
},
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "calc",
- "impliedEdits": {},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ]
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "role": "object",
+ "source": {
+ "description": "An integer number `[0..nodes.length - 1]` that represents the source node.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "sourcesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `source`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "target": {
+ "description": "An integer number `[0..nodes.length - 1]` that represents the target node.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "targetsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `target`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "value": {
+ "description": "A numeric value representing the flow volume value.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "valuesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `value`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "node": {
+ "align": {
+ "description": "Sets the alignment method used to position the nodes along the horizontal axis.",
+ "dflt": "justify",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "justify",
+ "left",
+ "right",
+ "center"
+ ]
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the `node` color. It can be a single value, or an array for specifying color for each `node`. If `node.color` is omitted, then the default `Plotly` color palette will be cycled through to have a variety of colors. These defaults are not fully opaque, to allow some visibility of what is beneath the node.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "customdata": {
+ "description": "Assigns extra data to each node.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "The nodes of the Sankey plot.",
+ "editType": "calc",
+ "groups": {
+ "description": "Groups of nodes. Each group is defined by an array with the indices of the nodes it contains. Multiple groups can be specified.",
+ "dflt": [],
+ "dimensions": 2,
+ "editType": "calc",
+ "freeLength": true,
+ "impliedEdits": {
+ "x": [],
+ "y": []
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
+ "items": {
"editType": "calc",
- "valType": "string"
+ "valType": "number"
},
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
+ "valType": "info_array"
+ },
+ "hoverinfo": {
+ "description": "Determines which trace information appear when hovering nodes. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "none",
+ "skip"
+ ]
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
"editType": "calc",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "left",
+ "right",
+ "auto"
]
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "calc",
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
"valType": "string"
},
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
"editType": "calc",
- "valType": "data_array"
+ "valType": "color"
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
"editType": "none",
"valType": "string"
},
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
"editType": "calc",
- "valType": "data_array"
+ "valType": "color"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
"editType": "none",
"valType": "string"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
"editType": "calc",
- "font": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
},
"role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "calc",
"valType": "enumerated",
"values": [
- "right",
- "top",
- "bottom"
+ "normal",
+ "italic"
]
},
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
"valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "calc",
- "valType": "number"
- },
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
"editType": "calc",
- "valType": "number"
+ "min": -1,
+ "valType": "integer"
},
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Variables `sourceLinks` and `targetLinks` are arrays of link objects.Finally, the template string has access to variables `value` and `label`. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "label": {
+ "description": "The shown name of the node.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "labelsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `label`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "line": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the color of the `line` around each `node`.",
+ "dflt": "#444",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "top",
- "middle",
- "bottom"
- ]
+ "valType": "color"
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the `line` around each `node`.",
+ "dflt": 0.5,
"editType": "calc",
"min": 0,
"valType": "number"
},
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
+ "pad": {
+ "arrayOk": false,
+ "description": "Sets the padding (in px) between the `nodes`.",
+ "dflt": 20,
"editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
+ "min": 0,
+ "valType": "number"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "role": "object",
+ "thickness": {
+ "arrayOk": false,
+ "description": "Sets the thickness (in px) of the `nodes`.",
+ "dflt": 20,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "x": {
+ "description": "The normalized horizontal position of the node.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
"editType": "none",
"valType": "string"
},
- "dash": {
- "description": "Sets the dash style of the lines.",
- "dflt": "solid",
+ "y": {
+ "description": "The normalized vertical position of the node.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "orientation": {
+ "description": "Sets the orientation of the Sankey diagram.",
+ "dflt": "h",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "v",
+ "h"
+ ]
+ },
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "textfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets the font for node labels",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "calc",
"valType": "enumerated",
"values": [
- "dash",
- "dashdot",
- "dot",
- "longdash",
- "longdashdot",
- "solid"
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "type": "sankey",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "valueformat": {
+ "description": "Sets the value formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.",
+ "dflt": ".3s",
"editType": "calc",
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `line.color` is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.",
- "dflt": false,
+ "valType": "string"
+ },
+ "valuesuffix": {
+ "description": "Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ }
+ },
+ "categories": [
+ "noOpacity"
+ ],
+ "meta": {
+ "description": "Sankey plots for network flow data analysis. The nodes are specified in `nodes` and the links between sources and targets in `links`. The colors are set in `nodes[i].color` and `links[i].color`, otherwise defaults are used."
+ },
+ "type": "sankey"
+ },
+ "scatter": {
+ "animatable": true,
+ "attributes": {
+ "alignmentgroup": {
+ "description": "Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "cliponaxis": {
+ "description": "Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and `yaxis.layer` to *below traces*.",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "dx": {
+ "anim": true,
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "dy": {
+ "anim": true,
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "error_x": {
+ "_deprecated": {
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "style",
+ "valType": "number"
+ }
+ },
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
"editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "copy_ystyle": {
+ "editType": "plot",
"valType": "boolean"
},
+ "editType": "calc",
"role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color` is set to a numerical array.",
- "dflt": false,
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
"editType": "calc",
"valType": "boolean"
},
- "width": {
- "description": "Sets the line width (in px).",
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
"dflt": 2,
- "editType": "calc",
+ "editType": "style",
"min": 0,
"valType": "number"
- }
- },
- "marker": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
- "dflt": true,
+ "traceref": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "enumerated",
+ "values": [
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
+ ]
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
- "dflt": null,
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
"editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
+ "min": 0,
"valType": "number"
},
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
- "dflt": null,
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
"editType": "calc",
- "impliedEdits": {},
+ "min": 0,
"valType": "number"
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
- "dflt": null,
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
"editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "plot",
+ "min": 0,
"valType": "number"
+ }
+ },
+ "error_y": {
+ "_deprecated": {
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "style",
+ "valType": "number"
+ }
},
- "color": {
- "arrayOk": true,
- "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
"editType": "calc",
- "valType": "color"
+ "valType": "data_array"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
},
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "calc",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- }
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "calc",
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object",
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "traceref": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
+ ]
+ },
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "fill": {
+ "description": "Sets the area to fill with a solid color. Defaults to *none* unless this trace is stacked, then it gets *tonexty* (*tonextx*) if `orientation` is *v* (*h*) Use with `fillcolor` if not *none*. *tozerox* and *tozeroy* fill to x=0 and y=0 respectively. *tonextx* and *tonexty* fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like *tozerox* and *tozeroy*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. *tonext* fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like *toself* if there is no trace before it. *tonext* should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "tozeroy",
+ "tozerox",
+ "tonexty",
+ "tonextx",
+ "toself",
+ "tonext"
+ ]
+ },
+ "fillcolor": {
+ "anim": true,
+ "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available. If fillgradient is specified, fillcolor is ignored except for setting the background color of the hover label, if any.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "fillgradient": {
+ "colorscale": {
+ "description": "Sets the fill gradient colors as a color scale. The color scale is interpreted as a gradient applied in the direction specified by *orientation*, from the lowest to the highest value of the scatter plot along that axis, or from the center to the most distant point from it, if orientation is *radial*.",
+ "editType": "style",
+ "valType": "colorscale"
+ },
+ "description": "Sets a fill gradient. If not specified, the fillcolor is used instead.",
+ "editType": "calc",
+ "role": "object",
+ "start": {
+ "description": "Sets the gradient start value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is *horizontal*, the gradient will be horizontal and start from the x-position given by start. If omitted, the gradient starts at the lowest value of the trace along the respective axis. Ignored if orientation is *radial*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "stop": {
+ "description": "Sets the gradient end value. It is given as the absolute position on the axis determined by the orientiation. E.g., if orientation is *horizontal*, the gradient will be horizontal and end at the x-position given by end. If omitted, the gradient ends at the highest value of the trace along the respective axis. Ignored if orientation is *radial*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "type": {
+ "description": "Sets the type/orientation of the color gradient for the fill. Defaults to *none*.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "radial",
+ "horizontal",
+ "vertical",
+ "none"
+ ]
+ }
+ },
+ "fillpattern": {
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the pattern within the marker.",
+ "editType": "style",
+ "fgcolor": {
+ "arrayOk": true,
+ "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "fgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "fgopacity": {
+ "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "fillmode": {
+ "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
+ "dflt": "replace",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "replace",
+ "overlay"
+ ]
+ },
+ "role": "object",
+ "shape": {
+ "arrayOk": true,
+ "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "",
+ "/",
+ "\\",
+ "x",
+ "-",
+ "|",
+ "+",
+ "."
+ ]
+ },
+ "shapesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
+ "dflt": 8,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "solidity": {
+ "arrayOk": true,
+ "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
+ "dflt": 0.3,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "soliditysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "groupnorm": {
+ "description": "Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Sets the normalization for the sum of this `stackgroup`. With *fraction*, the value of each trace at each location is divided by the sum of all trace values at that location. *percent* is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "",
+ "fraction",
+ "percent"
+ ]
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
"valType": "color"
},
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
},
- "editType": "calc",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "calc",
- "valType": "any"
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
},
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
},
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
"valType": "number"
},
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "calc",
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "italic"
]
},
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "calc",
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
},
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "calc",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "calc",
- "valType": "angle"
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "calc",
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "hoveron": {
+ "description": "Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is *toself* or *tonext* and there are no markers or text, then the default is *fills*, otherwise it is *points*.",
+ "editType": "style",
+ "flags": [
+ "points",
+ "fills"
+ ],
+ "valType": "flaglist"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "anim": true,
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
"valType": "color"
},
- "tickfont": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Sets the color bar's tick label font",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "calc",
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
},
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "valType": "any"
- },
- {
- "editType": "calc",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "calc",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "calc",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
},
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "calc",
+ "size": {
+ "editType": "style",
"min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "calc",
- "min": 0,
"valType": "number"
},
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "calc",
- "impliedEdits": {},
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "auto",
- "linear",
- "array"
+ "normal",
+ "italic"
]
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "calc",
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "calc",
- "valType": "data_array"
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
- },
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "calc",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "line": {
+ "backoff": {
+ "arrayOk": true,
+ "description": "Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With *auto* the lines would trim before markers if `marker.angleref` is set to *previous*.",
+ "dflt": "auto",
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
+ "backoffsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "anim": true,
+ "description": "Sets the line color.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "dash": {
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
+ "dflt": "solid",
+ "editType": "style",
+ "valType": "string",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ]
+ },
+ "editType": "plot",
+ "role": "object",
+ "shape": {
+ "description": "Determines the line shape. With *spline* the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.",
+ "dflt": "linear",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "linear",
+ "spline",
+ "hv",
+ "vh",
+ "hvh",
+ "vhv"
+ ]
+ },
+ "simplify": {
+ "description": "Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "smoothing": {
+ "description": "Has an effect only if `shape` is set to *spline* Sets the amount of smoothing. *0* corresponds to no smoothing (equivalent to a *linear* shape).",
+ "dflt": 1,
+ "editType": "plot",
+ "max": 1.3,
+ "min": 0,
+ "valType": "number"
+ },
+ "width": {
+ "anim": true,
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "marker": {
+ "angle": {
+ "anim": false,
+ "arrayOk": true,
+ "description": "Sets the marker angle in respect to `angleref`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "angle"
+ },
+ "angleref": {
+ "anim": false,
+ "description": "Sets the reference for marker angle. With *previous*, angle 0 points along the line from the previous point to this one. With *up*, angle 0 points toward the top of the screen.",
+ "dflt": "up",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "previous",
+ "up"
+ ]
+ },
+ "anglesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
},
- "title": {
- "editType": "calc",
- "font": {
+ "valType": "number"
+ },
+ "color": {
+ "anim": true,
+ "arrayOk": true,
+ "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "titlefont": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color"
},
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "calc",
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -65990,7 +64998,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -66001,22 +65009,21 @@
],
"valType": "flaglist"
},
- "role": "object",
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -66026,7 +65033,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -66038,7 +65045,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -66052,7 +65059,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -66062,1870 +65069,2695 @@
"valType": "integer"
}
},
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "calc",
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"right",
"top",
"bottom"
]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "calc",
- "valType": "string"
}
},
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "calc",
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "calc",
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "colorbars",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "colorbars",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "left",
- "center",
- "right"
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
]
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "calc",
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "calc",
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "fraction",
+ "pixels"
]
},
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "calc",
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "calc",
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "top",
- "middle",
- "bottom"
+ "h",
+ "v"
]
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "calc",
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "all",
+ "first",
+ "last",
+ "none"
]
- }
- },
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "calc",
- "impliedEdits": {},
+ "editType": "colorbars",
"valType": "boolean"
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "colorbars",
+ "min": 0,
"valType": "number"
},
- "color": {
- "arrayOk": true,
- "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
- "editType": "calc",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "colorbars",
"impliedEdits": {
- "autocolorscale": false
+ "tickmode": "linear"
},
- "valType": "colorscale"
+ "valType": "any"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "colorbars",
+ "valType": "angle"
},
- "editType": "calc",
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color"
},
- "role": "object",
- "width": {
- "arrayOk": false,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- }
- },
- "opacity": {
- "arrayOk": false,
- "description": "Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for performance reasons. To set a blending opacity value (i.e. which is not transparent), set *marker.color* to an rgba color and use its alpha channel.",
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "size": {
- "arrayOk": true,
- "description": "Sets the marker size (in px).",
- "dflt": 8,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "sizemin": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "sizemode": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
- "dflt": "diameter",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "diameter",
- "area"
- ]
- },
- "sizeref": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "symbol": {
- "arrayOk": true,
- "description": "Sets the marker symbol type.",
- "dflt": "circle",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "circle",
- "circle-open",
- "cross",
- "diamond",
- "diamond-open",
- "square",
- "square-open",
- "x"
- ]
- },
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "mode": {
- "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.",
- "dflt": "lines+markers",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "lines",
- "markers",
- "text"
- ],
- "valType": "flaglist"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "projection": {
- "editType": "calc",
- "role": "object",
- "x": {
- "editType": "calc",
- "opacity": {
- "description": "Sets the projection color.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
},
- "role": "object",
- "scale": {
- "description": "Sets the scale factor determining the size of the projection marker points.",
- "dflt": 0.6666666666666666,
- "editType": "calc",
- "max": 10,
- "min": 0,
- "valType": "number"
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
},
- "show": {
- "description": "Sets whether or not projections are shown along the x axis.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- }
- },
- "y": {
- "editType": "calc",
- "opacity": {
- "description": "Sets the projection color.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "colorbars",
+ "items": [
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ },
+ {
+ "editType": "colorbars",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "colorbars",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
},
- "role": "object",
- "scale": {
- "description": "Sets the scale factor determining the size of the projection marker points.",
- "dflt": 0.6666666666666666,
- "editType": "calc",
- "max": 10,
- "min": 0,
- "valType": "number"
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
},
- "show": {
- "description": "Sets whether or not projections are shown along the y axis.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- }
- },
- "z": {
- "editType": "calc",
- "opacity": {
- "description": "Sets the projection color.",
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
"dflt": 1,
- "editType": "calc",
- "max": 1,
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
- "role": "object",
- "scale": {
- "description": "Sets the scale factor determining the size of the projection marker points.",
- "dflt": 0.6666666666666666,
- "editType": "calc",
- "max": 10,
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "colorbars",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "colorbars",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
- "show": {
- "description": "Sets whether or not projections are shown along the z axis.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- }
- }
- },
- "scene": {
- "description": "Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.",
- "dflt": "scene",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean"
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "surfaceaxis": {
- "description": "If *-1*, the scatter points are not fill with a surface If *0*, *1*, *2*, the scatter points are filled with a Delaunay surface about the x, y, z respectively.",
- "dflt": -1,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- -1,
- 0,
- 1,
- 2
- ]
- },
- "surfacecolor": {
- "description": "Sets the surface fill color.",
- "editType": "calc",
- "valType": "color"
- },
- "text": {
- "arrayOk": true,
- "description": "Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "calc",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the text font.",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "size": {
- "arrayOk": true,
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "colorbars",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "colorbars",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "colorbars",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "colorbars",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
- "min": 1,
- "valType": "number"
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
"valType": "string"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
+ "editType": "calc",
+ "gradient": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
+ "role": "object",
+ "type": {
+ "arrayOk": true,
+ "description": "Sets the type of gradient used to fill the markers",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "radial",
+ "horizontal",
+ "vertical",
+ "none"
+ ]
+ },
+ "typesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `type`.",
+ "editType": "none",
+ "valType": "string"
+ }
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "anim": true,
+ "arrayOk": true,
+ "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "width": {
+ "anim": true,
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "maxdisplayed": {
+ "description": "Sets a maximum number of points to be drawn on the graph. *0* corresponds to no limit.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
+ "opacity": {
+ "anim": true,
+ "arrayOk": true,
+ "description": "Sets the marker opacity.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "opacitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
"editType": "none",
"valType": "string"
},
- "variant": {
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "size": {
+ "anim": true,
"arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
+ "description": "Sets the marker size (in px).",
+ "dflt": 6,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemin": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemode": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
+ "dflt": "diameter",
"editType": "calc",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps"
+ "diameter",
+ "area"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "sizeref": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
"editType": "none",
"valType": "string"
},
- "weight": {
+ "standoff": {
+ "anim": true,
"arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "description": "Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "standoffsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `standoff`.",
"editType": "none",
"valType": "string"
- }
- },
- "textposition": {
- "arrayOk": true,
- "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
- "dflt": "top center",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "top left",
- "top center",
- "top right",
- "middle left",
- "middle center",
- "middle right",
- "bottom left",
- "bottom center",
- "bottom right"
- ]
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
},
- "role": "object"
- },
- "type": "scatter3d",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- },
- "x": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "y": {
- "description": "Sets the y coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "ycalendar": {
- "description": "Sets the calendar system to use with `y` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "z": {
- "description": "Sets the z coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "zcalendar": {
- "description": "Sets the calendar system to use with `z` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "zhoverformat": {
- "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `zaxis.hoverformat`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "categories": [
- "gl3d",
- "symbols",
- "showLegend",
- "scatter-like"
- ],
- "meta": {
- "description": "The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.",
- "hrName": "scatter_3d"
- },
- "type": "scatter3d"
- },
- "scattercarpet": {
- "animatable": false,
- "attributes": {
- "a": {
- "description": "Sets the a-axis coordinates.",
- "editType": "calc",
- "valType": "data_array"
- },
- "asrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `a`.",
- "editType": "none",
- "valType": "string"
- },
- "b": {
- "description": "Sets the b-axis coordinates.",
- "editType": "calc",
- "valType": "data_array"
- },
- "bsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `b`.",
- "editType": "none",
- "valType": "string"
- },
- "carpet": {
- "description": "An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie",
- "editType": "calc",
- "valType": "string"
- },
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "fill": {
- "description": "Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. scatterternary has a subset of the options available to scatter. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. *tonext* fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like *toself* if there is no trace before it. *tonext* should not be used if one trace does not enclose the other.",
- "dflt": "none",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "toself",
- "tonext"
- ]
- },
- "fillcolor": {
- "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.",
- "editType": "style",
- "valType": "color"
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "none",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "a",
- "b",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
+ "symbol": {
"arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
+ "description": "Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name.",
+ "dflt": "circle",
+ "editType": "style",
"valType": "enumerated",
"values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
- },
- "hoveron": {
- "description": "Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is *toself* or *tonext* and there are no markers or text, then the default is *fills*, otherwise it is *points*.",
- "editType": "style",
- "flags": [
- "points",
- "fills"
- ],
- "valType": "flaglist"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "none",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color"
- },
- "description": "Sets this legend group's title font.",
- "editType": "style",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "style",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "style",
- "valType": "string"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ 0,
+ "0",
+ "circle",
+ 100,
+ "100",
+ "circle-open",
+ 200,
+ "200",
+ "circle-dot",
+ 300,
+ "300",
+ "circle-open-dot",
+ 1,
+ "1",
+ "square",
+ 101,
+ "101",
+ "square-open",
+ 201,
+ "201",
+ "square-dot",
+ 301,
+ "301",
+ "square-open-dot",
+ 2,
+ "2",
+ "diamond",
+ 102,
+ "102",
+ "diamond-open",
+ 202,
+ "202",
+ "diamond-dot",
+ 302,
+ "302",
+ "diamond-open-dot",
+ 3,
+ "3",
+ "cross",
+ 103,
+ "103",
+ "cross-open",
+ 203,
+ "203",
+ "cross-dot",
+ 303,
+ "303",
+ "cross-open-dot",
+ 4,
+ "4",
+ "x",
+ 104,
+ "104",
+ "x-open",
+ 204,
+ "204",
+ "x-dot",
+ 304,
+ "304",
+ "x-open-dot",
+ 5,
+ "5",
+ "triangle-up",
+ 105,
+ "105",
+ "triangle-up-open",
+ 205,
+ "205",
+ "triangle-up-dot",
+ 305,
+ "305",
+ "triangle-up-open-dot",
+ 6,
+ "6",
+ "triangle-down",
+ 106,
+ "106",
+ "triangle-down-open",
+ 206,
+ "206",
+ "triangle-down-dot",
+ 306,
+ "306",
+ "triangle-down-open-dot",
+ 7,
+ "7",
+ "triangle-left",
+ 107,
+ "107",
+ "triangle-left-open",
+ 207,
+ "207",
+ "triangle-left-dot",
+ 307,
+ "307",
+ "triangle-left-open-dot",
+ 8,
+ "8",
+ "triangle-right",
+ 108,
+ "108",
+ "triangle-right-open",
+ 208,
+ "208",
+ "triangle-right-dot",
+ 308,
+ "308",
+ "triangle-right-open-dot",
+ 9,
+ "9",
+ "triangle-ne",
+ 109,
+ "109",
+ "triangle-ne-open",
+ 209,
+ "209",
+ "triangle-ne-dot",
+ 309,
+ "309",
+ "triangle-ne-open-dot",
+ 10,
+ "10",
+ "triangle-se",
+ 110,
+ "110",
+ "triangle-se-open",
+ 210,
+ "210",
+ "triangle-se-dot",
+ 310,
+ "310",
+ "triangle-se-open-dot",
+ 11,
+ "11",
+ "triangle-sw",
+ 111,
+ "111",
+ "triangle-sw-open",
+ 211,
+ "211",
+ "triangle-sw-dot",
+ 311,
+ "311",
+ "triangle-sw-open-dot",
+ 12,
+ "12",
+ "triangle-nw",
+ 112,
+ "112",
+ "triangle-nw-open",
+ 212,
+ "212",
+ "triangle-nw-dot",
+ 312,
+ "312",
+ "triangle-nw-open-dot",
+ 13,
+ "13",
+ "pentagon",
+ 113,
+ "113",
+ "pentagon-open",
+ 213,
+ "213",
+ "pentagon-dot",
+ 313,
+ "313",
+ "pentagon-open-dot",
+ 14,
+ "14",
+ "hexagon",
+ 114,
+ "114",
+ "hexagon-open",
+ 214,
+ "214",
+ "hexagon-dot",
+ 314,
+ "314",
+ "hexagon-open-dot",
+ 15,
+ "15",
+ "hexagon2",
+ 115,
+ "115",
+ "hexagon2-open",
+ 215,
+ "215",
+ "hexagon2-dot",
+ 315,
+ "315",
+ "hexagon2-open-dot",
+ 16,
+ "16",
+ "octagon",
+ 116,
+ "116",
+ "octagon-open",
+ 216,
+ "216",
+ "octagon-dot",
+ 316,
+ "316",
+ "octagon-open-dot",
+ 17,
+ "17",
+ "star",
+ 117,
+ "117",
+ "star-open",
+ 217,
+ "217",
+ "star-dot",
+ 317,
+ "317",
+ "star-open-dot",
+ 18,
+ "18",
+ "hexagram",
+ 118,
+ "118",
+ "hexagram-open",
+ 218,
+ "218",
+ "hexagram-dot",
+ 318,
+ "318",
+ "hexagram-open-dot",
+ 19,
+ "19",
+ "star-triangle-up",
+ 119,
+ "119",
+ "star-triangle-up-open",
+ 219,
+ "219",
+ "star-triangle-up-dot",
+ 319,
+ "319",
+ "star-triangle-up-open-dot",
+ 20,
+ "20",
+ "star-triangle-down",
+ 120,
+ "120",
+ "star-triangle-down-open",
+ 220,
+ "220",
+ "star-triangle-down-dot",
+ 320,
+ "320",
+ "star-triangle-down-open-dot",
+ 21,
+ "21",
+ "star-square",
+ 121,
+ "121",
+ "star-square-open",
+ 221,
+ "221",
+ "star-square-dot",
+ 321,
+ "321",
+ "star-square-open-dot",
+ 22,
+ "22",
+ "star-diamond",
+ 122,
+ "122",
+ "star-diamond-open",
+ 222,
+ "222",
+ "star-diamond-dot",
+ 322,
+ "322",
+ "star-diamond-open-dot",
+ 23,
+ "23",
+ "diamond-tall",
+ 123,
+ "123",
+ "diamond-tall-open",
+ 223,
+ "223",
+ "diamond-tall-dot",
+ 323,
+ "323",
+ "diamond-tall-open-dot",
+ 24,
+ "24",
+ "diamond-wide",
+ 124,
+ "124",
+ "diamond-wide-open",
+ 224,
+ "224",
+ "diamond-wide-dot",
+ 324,
+ "324",
+ "diamond-wide-open-dot",
+ 25,
+ "25",
+ "hourglass",
+ 125,
+ "125",
+ "hourglass-open",
+ 26,
+ "26",
+ "bowtie",
+ 126,
+ "126",
+ "bowtie-open",
+ 27,
+ "27",
+ "circle-cross",
+ 127,
+ "127",
+ "circle-cross-open",
+ 28,
+ "28",
+ "circle-x",
+ 128,
+ "128",
+ "circle-x-open",
+ 29,
+ "29",
+ "square-cross",
+ 129,
+ "129",
+ "square-cross-open",
+ 30,
+ "30",
+ "square-x",
+ 130,
+ "130",
+ "square-x-open",
+ 31,
+ "31",
+ "diamond-cross",
+ 131,
+ "131",
+ "diamond-cross-open",
+ 32,
+ "32",
+ "diamond-x",
+ 132,
+ "132",
+ "diamond-x-open",
+ 33,
+ "33",
+ "cross-thin",
+ 133,
+ "133",
+ "cross-thin-open",
+ 34,
+ "34",
+ "x-thin",
+ 134,
+ "134",
+ "x-thin-open",
+ 35,
+ "35",
+ "asterisk",
+ 135,
+ "135",
+ "asterisk-open",
+ 36,
+ "36",
+ "hash",
+ 136,
+ "136",
+ "hash-open",
+ 236,
+ "236",
+ "hash-dot",
+ 336,
+ "336",
+ "hash-open-dot",
+ 37,
+ "37",
+ "y-up",
+ 137,
+ "137",
+ "y-up-open",
+ 38,
+ "38",
+ "y-down",
+ 138,
+ "138",
+ "y-down-open",
+ 39,
+ "39",
+ "y-left",
+ 139,
+ "139",
+ "y-left-open",
+ 40,
+ "40",
+ "y-right",
+ 140,
+ "140",
+ "y-right-open",
+ 41,
+ "41",
+ "line-ew",
+ 141,
+ "141",
+ "line-ew-open",
+ 42,
+ "42",
+ "line-ns",
+ 142,
+ "142",
+ "line-ns-open",
+ 43,
+ "43",
+ "line-ne",
+ 143,
+ "143",
+ "line-ne-open",
+ 44,
+ "44",
+ "line-nw",
+ 144,
+ "144",
+ "line-nw-open",
+ 45,
+ "45",
+ "arrow-up",
+ 145,
+ "145",
+ "arrow-up-open",
+ 46,
+ "46",
+ "arrow-down",
+ 146,
+ "146",
+ "arrow-down-open",
+ 47,
+ "47",
+ "arrow-left",
+ 147,
+ "147",
+ "arrow-left-open",
+ 48,
+ "48",
+ "arrow-right",
+ 148,
+ "148",
+ "arrow-right-open",
+ 49,
+ "49",
+ "arrow-bar-up",
+ 149,
+ "149",
+ "arrow-bar-up-open",
+ 50,
+ "50",
+ "arrow-bar-down",
+ 150,
+ "150",
+ "arrow-bar-down-open",
+ 51,
+ "51",
+ "arrow-bar-left",
+ 151,
+ "151",
+ "arrow-bar-left-open",
+ 52,
+ "52",
+ "arrow-bar-right",
+ 152,
+ "152",
+ "arrow-bar-right-open",
+ 53,
+ "53",
+ "arrow",
+ 153,
+ "153",
+ "arrow-open",
+ 54,
+ "54",
+ "arrow-wide",
+ 154,
+ "154",
+ "arrow-wide-open"
+ ]
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
+ "symbolsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
+ "editType": "none",
+ "valType": "string"
}
},
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "mode": {
+ "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "lines",
+ "markers",
+ "text"
+ ],
+ "valType": "flaglist"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
- "valType": "number"
+ "valType": "string"
},
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "offsetgroup": {
+ "description": "Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
"editType": "style",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "line": {
- "backoff": {
- "arrayOk": true,
- "description": "Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With *auto* the lines would trim before markers if `marker.angleref` is set to *previous*.",
- "dflt": "auto",
- "editType": "plot",
+ "orientation": {
+ "description": "Only relevant in the following cases: 1. when `scattermode` is set to *group*. 2. when `stackgroup` is used, and only the first `orientation` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Sets the stacking direction. With *v* (*h*), the y (x) values of subsequent traces are added. Also affects the default value of `fill`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "v",
+ "h"
+ ]
+ },
+ "selected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of selected points.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of selected points.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of selected points.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "role": "object"
+ }
+ },
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "stackgaps": {
+ "description": "Only relevant when `stackgroup` is used, and only the first `stackgaps` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Determines how we handle locations at which other traces in this group have data but this one does not. With *infer zero* we insert a zero at these locations. With *interpolate* we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.",
+ "dflt": "infer zero",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "infer zero",
+ "interpolate"
+ ]
+ },
+ "stackgroup": {
+ "description": "Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if `orientation` is *h*). If blank or omitted this trace will not be stacked. Stacking also turns `fill` on by default, using *tonexty* (*tonextx*) if `orientation` is *h* (*v*) and sets the default `mode` to *lines* irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
"min": 0,
"valType": "number"
},
- "backoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
- "editType": "none",
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
"valType": "string"
- },
+ }
+ },
+ "text": {
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textfont": {
"color": {
- "description": "Sets the line color.",
+ "arrayOk": true,
"editType": "style",
"valType": "color"
},
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
- "dflt": "solid",
- "editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ]
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
+ "description": "Sets the text font.",
"editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
"role": "object",
- "shape": {
- "description": "Determines the line shape. With *spline* the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.",
- "dflt": "linear",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "linear",
- "spline"
- ]
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
},
- "smoothing": {
- "description": "Has an effect only if `shape` is set to *spline* Sets the amount of smoothing. *0* corresponds to no smoothing (equivalent to a *linear* shape).",
- "dflt": 1,
- "editType": "plot",
- "max": 1.3,
- "min": 0,
- "valType": "number"
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
},
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number"
- }
- },
- "marker": {
- "angle": {
+ "size": {
"arrayOk": true,
- "description": "Sets the marker angle in respect to `angleref`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "angle"
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
},
- "angleref": {
- "description": "Sets the reference for marker angle. With *previous*, angle 0 points along the line from the previous point to this one. With *up*, angle 0 points toward the top of the screen.",
- "dflt": "up",
- "editType": "plot",
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "previous",
- "up"
+ "normal",
+ "italic"
]
},
- "anglesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
"editType": "none",
"valType": "string"
},
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
- "dflt": true,
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
},
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
- "dflt": null,
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "calc",
- "impliedEdits": {},
- "valType": "number"
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "textposition": {
+ "arrayOk": true,
+ "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
+ "dflt": "middle center",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle left",
+ "middle center",
+ "middle right",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ]
+ },
+ "textpositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
},
- "color": {
- "arrayOk": true,
- "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
+ "role": "object"
+ },
+ "type": "scatter",
+ "uid": {
+ "anim": true,
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "unselected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color"
+ },
"editType": "style",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "opacity": {
+ "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ }
},
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "colorbars",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- }
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of unselected points, applied only when a selection exists.",
+ "editType": "style",
"valType": "color"
},
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "editType": "colorbars",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
- ]
- },
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "colorbars",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
- },
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
- },
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
- "editType": "colorbars",
- "min": 0,
+ "editType": "style",
+ "role": "object"
+ }
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ },
+ "x": {
+ "anim": true,
+ "description": "Sets the x coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "x0": {
+ "anim": true,
+ "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "valType": "any"
+ },
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "xperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "xperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "xperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
+ "dflt": "middle",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
+ },
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "y": {
+ "anim": true,
+ "description": "Sets the y coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "y0": {
+ "anim": true,
+ "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "valType": "any"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "yperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "yperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "yperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
+ "dflt": "middle",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
+ },
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ }
+ },
+ "categories": [
+ "cartesian",
+ "svg",
+ "symbols",
+ "errorBarsOK",
+ "showLegend",
+ "scatter-like",
+ "zoomScale"
+ ],
+ "layoutAttributes": {
+ "scattergap": {
+ "description": "Sets the gap (in plot fraction) between scatter points of adjacent location coordinates. Defaults to `bargap`.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "scattermode": {
+ "description": "Determines how scatter points at the same location coordinate are displayed on the graph. With *group*, the scatter points are plotted next to one another centered around the shared location. With *overlay*, the scatter points are plotted over one another, you might need to reduce *opacity* to see multiple scatter points.",
+ "dflt": "overlay",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "group",
+ "overlay"
+ ]
+ }
+ },
+ "meta": {
+ "description": "The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in `x` and `y`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to numerical arrays."
+ },
+ "type": "scatter"
+ },
+ "scatter3d": {
+ "animatable": false,
+ "attributes": {
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "error_x": {
+ "_deprecated": {
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "calc",
"valType": "number"
- },
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ]
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
+ }
+ },
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "copy_zstyle": {
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "editType": "calc",
+ "role": "object",
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "traceref": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
+ ]
+ },
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "error_y": {
+ "_deprecated": {
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "calc",
"valType": "number"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
- "min": 0,
+ }
+ },
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "copy_zstyle": {
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "editType": "calc",
+ "role": "object",
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "traceref": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
+ ]
+ },
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "error_z": {
+ "_deprecated": {
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "calc",
"valType": "number"
+ }
+ },
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object",
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "traceref": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
+ ]
+ },
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "calc",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color"
},
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "colorbars",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "colorbars",
- "valType": "angle"
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color"
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "tickfont": {
- "color": {
- "editType": "colorbars",
- "valType": "color"
- },
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "colorbars",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "colorbars",
- "valType": "string"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "colorbars",
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
"valType": "string"
},
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "colorbars",
- "items": [
- {
- "editType": "colorbars",
- "valType": "any"
- },
- {
- "editType": "colorbars",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "colorbars",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "colorbars",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "colorbars",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string"
- }
- }
- },
- "role": "object"
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
},
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "colorbars",
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "allow",
- "hide past div",
- "hide past domain"
+ "normal",
+ "italic"
]
},
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
- },
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number"
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "colorbars",
- "impliedEdits": {},
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "auto",
- "linear",
- "array"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
]
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
"valType": "string"
},
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "colorbars",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
]
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
"valType": "string"
},
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "colorbars",
- "valType": "data_array"
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
"editType": "none",
"valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "colorbars",
- "valType": "data_array"
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
"valType": "string"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
+ "size": {
+ "editType": "style",
+ "min": 1,
"valType": "number"
},
- "title": {
- "editType": "colorbars",
- "font": {
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color` is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `line.color` is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `line.cmin` and `line.cmax` if set.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "titlefont": {
"color": {
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color"
},
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "colorbars",
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "calc",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "colorbars",
+ "editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -67933,7 +67765,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"none"
],
@@ -67944,22 +67776,21 @@
],
"valType": "flaglist"
},
- "role": "object",
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string"
},
"size": {
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -67969,7 +67800,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -67981,7 +67812,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -67995,7 +67826,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"normal",
"bold"
@@ -68005,3579 +67836,2113 @@
"valType": "integer"
}
},
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "colorbars",
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"right",
"top",
"bottom"
]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "colorbars",
- "valType": "string"
}
},
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "colorbars",
- "valType": "number"
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color"
},
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
"min": 0,
"valType": "number"
},
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "calc",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
]
},
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "colorbars",
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
"valType": "number"
},
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "colorbars",
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "top",
- "middle",
- "bottom"
+ "fraction",
+ "pixels"
]
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "calc",
"min": 0,
"valType": "number"
},
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
- "editType": "colorbars",
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "container",
- "paper"
+ "h",
+ "v"
]
- }
- },
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
},
- "valType": "colorscale"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "gradient": {
- "color": {
- "arrayOk": true,
- "description": "Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.",
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
"editType": "calc",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
},
- "editType": "calc",
"role": "object",
- "type": {
- "arrayOk": true,
- "description": "Sets the type of gradient used to fill the markers",
- "dflt": "none",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
"editType": "calc",
"valType": "enumerated",
"values": [
- "radial",
- "horizontal",
- "vertical",
+ "all",
+ "first",
+ "last",
"none"
]
},
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
"editType": "calc",
- "impliedEdits": {},
"valType": "boolean"
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
- "dflt": true,
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
"editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
- "dflt": null,
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
"editType": "calc",
- "impliedEdits": {},
+ "min": 0,
"valType": "number"
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
- "dflt": null,
- "editType": "plot",
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "calc",
"impliedEdits": {
- "cauto": false
+ "tickmode": "linear"
},
- "valType": "number"
+ "valType": "any"
},
- "color": {
- "arrayOk": true,
- "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
- "editType": "style",
- "valType": "color"
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "angle"
},
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
"editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
+ "valType": "color"
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
+ "tickfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
"editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "valType": "colorscale"
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "calc",
"valType": "string"
},
- "editType": "calc",
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "any"
+ },
+ {
+ "editType": "calc",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "calc",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
},
- "role": "object",
- "width": {
- "arrayOk": true,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "editType": "style",
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
+ },
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
"min": 0,
"valType": "number"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
"editType": "none",
"valType": "string"
- }
- },
- "maxdisplayed": {
- "description": "Sets a maximum number of points to be drawn on the graph. *0* corresponds to no limit.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "opacity": {
- "arrayOk": true,
- "description": "Sets the marker opacity.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "editType": "none",
- "valType": "string"
- },
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean"
- },
- "role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "size": {
- "arrayOk": true,
- "description": "Sets the marker size (in px).",
- "dflt": 6,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "sizemin": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "sizemode": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
- "dflt": "diameter",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "diameter",
- "area"
- ]
- },
- "sizeref": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "standoff": {
- "arrayOk": true,
- "description": "Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number"
- },
- "standoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `standoff`.",
- "editType": "none",
- "valType": "string"
- },
- "symbol": {
- "arrayOk": true,
- "description": "Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name.",
- "dflt": "circle",
- "editType": "style",
- "valType": "enumerated",
- "values": [
- 0,
- "0",
- "circle",
- 100,
- "100",
- "circle-open",
- 200,
- "200",
- "circle-dot",
- 300,
- "300",
- "circle-open-dot",
- 1,
- "1",
- "square",
- 101,
- "101",
- "square-open",
- 201,
- "201",
- "square-dot",
- 301,
- "301",
- "square-open-dot",
- 2,
- "2",
- "diamond",
- 102,
- "102",
- "diamond-open",
- 202,
- "202",
- "diamond-dot",
- 302,
- "302",
- "diamond-open-dot",
- 3,
- "3",
- "cross",
- 103,
- "103",
- "cross-open",
- 203,
- "203",
- "cross-dot",
- 303,
- "303",
- "cross-open-dot",
- 4,
- "4",
- "x",
- 104,
- "104",
- "x-open",
- 204,
- "204",
- "x-dot",
- 304,
- "304",
- "x-open-dot",
- 5,
- "5",
- "triangle-up",
- 105,
- "105",
- "triangle-up-open",
- 205,
- "205",
- "triangle-up-dot",
- 305,
- "305",
- "triangle-up-open-dot",
- 6,
- "6",
- "triangle-down",
- 106,
- "106",
- "triangle-down-open",
- 206,
- "206",
- "triangle-down-dot",
- 306,
- "306",
- "triangle-down-open-dot",
- 7,
- "7",
- "triangle-left",
- 107,
- "107",
- "triangle-left-open",
- 207,
- "207",
- "triangle-left-dot",
- 307,
- "307",
- "triangle-left-open-dot",
- 8,
- "8",
- "triangle-right",
- 108,
- "108",
- "triangle-right-open",
- 208,
- "208",
- "triangle-right-dot",
- 308,
- "308",
- "triangle-right-open-dot",
- 9,
- "9",
- "triangle-ne",
- 109,
- "109",
- "triangle-ne-open",
- 209,
- "209",
- "triangle-ne-dot",
- 309,
- "309",
- "triangle-ne-open-dot",
- 10,
- "10",
- "triangle-se",
- 110,
- "110",
- "triangle-se-open",
- 210,
- "210",
- "triangle-se-dot",
- 310,
- "310",
- "triangle-se-open-dot",
- 11,
- "11",
- "triangle-sw",
- 111,
- "111",
- "triangle-sw-open",
- 211,
- "211",
- "triangle-sw-dot",
- 311,
- "311",
- "triangle-sw-open-dot",
- 12,
- "12",
- "triangle-nw",
- 112,
- "112",
- "triangle-nw-open",
- 212,
- "212",
- "triangle-nw-dot",
- 312,
- "312",
- "triangle-nw-open-dot",
- 13,
- "13",
- "pentagon",
- 113,
- "113",
- "pentagon-open",
- 213,
- "213",
- "pentagon-dot",
- 313,
- "313",
- "pentagon-open-dot",
- 14,
- "14",
- "hexagon",
- 114,
- "114",
- "hexagon-open",
- 214,
- "214",
- "hexagon-dot",
- 314,
- "314",
- "hexagon-open-dot",
- 15,
- "15",
- "hexagon2",
- 115,
- "115",
- "hexagon2-open",
- 215,
- "215",
- "hexagon2-dot",
- 315,
- "315",
- "hexagon2-open-dot",
- 16,
- "16",
- "octagon",
- 116,
- "116",
- "octagon-open",
- 216,
- "216",
- "octagon-dot",
- 316,
- "316",
- "octagon-open-dot",
- 17,
- "17",
- "star",
- 117,
- "117",
- "star-open",
- 217,
- "217",
- "star-dot",
- 317,
- "317",
- "star-open-dot",
- 18,
- "18",
- "hexagram",
- 118,
- "118",
- "hexagram-open",
- 218,
- "218",
- "hexagram-dot",
- 318,
- "318",
- "hexagram-open-dot",
- 19,
- "19",
- "star-triangle-up",
- 119,
- "119",
- "star-triangle-up-open",
- 219,
- "219",
- "star-triangle-up-dot",
- 319,
- "319",
- "star-triangle-up-open-dot",
- 20,
- "20",
- "star-triangle-down",
- 120,
- "120",
- "star-triangle-down-open",
- 220,
- "220",
- "star-triangle-down-dot",
- 320,
- "320",
- "star-triangle-down-open-dot",
- 21,
- "21",
- "star-square",
- 121,
- "121",
- "star-square-open",
- 221,
- "221",
- "star-square-dot",
- 321,
- "321",
- "star-square-open-dot",
- 22,
- "22",
- "star-diamond",
- 122,
- "122",
- "star-diamond-open",
- 222,
- "222",
- "star-diamond-dot",
- 322,
- "322",
- "star-diamond-open-dot",
- 23,
- "23",
- "diamond-tall",
- 123,
- "123",
- "diamond-tall-open",
- 223,
- "223",
- "diamond-tall-dot",
- 323,
- "323",
- "diamond-tall-open-dot",
- 24,
- "24",
- "diamond-wide",
- 124,
- "124",
- "diamond-wide-open",
- 224,
- "224",
- "diamond-wide-dot",
- 324,
- "324",
- "diamond-wide-open-dot",
- 25,
- "25",
- "hourglass",
- 125,
- "125",
- "hourglass-open",
- 26,
- "26",
- "bowtie",
- 126,
- "126",
- "bowtie-open",
- 27,
- "27",
- "circle-cross",
- 127,
- "127",
- "circle-cross-open",
- 28,
- "28",
- "circle-x",
- 128,
- "128",
- "circle-x-open",
- 29,
- "29",
- "square-cross",
- 129,
- "129",
- "square-cross-open",
- 30,
- "30",
- "square-x",
- 130,
- "130",
- "square-x-open",
- 31,
- "31",
- "diamond-cross",
- 131,
- "131",
- "diamond-cross-open",
- 32,
- "32",
- "diamond-x",
- 132,
- "132",
- "diamond-x-open",
- 33,
- "33",
- "cross-thin",
- 133,
- "133",
- "cross-thin-open",
- 34,
- "34",
- "x-thin",
- 134,
- "134",
- "x-thin-open",
- 35,
- "35",
- "asterisk",
- 135,
- "135",
- "asterisk-open",
- 36,
- "36",
- "hash",
- 136,
- "136",
- "hash-open",
- 236,
- "236",
- "hash-dot",
- 336,
- "336",
- "hash-open-dot",
- 37,
- "37",
- "y-up",
- 137,
- "137",
- "y-up-open",
- 38,
- "38",
- "y-down",
- 138,
- "138",
- "y-down-open",
- 39,
- "39",
- "y-left",
- 139,
- "139",
- "y-left-open",
- 40,
- "40",
- "y-right",
- 140,
- "140",
- "y-right-open",
- 41,
- "41",
- "line-ew",
- 141,
- "141",
- "line-ew-open",
- 42,
- "42",
- "line-ns",
- 142,
- "142",
- "line-ns-open",
- 43,
- "43",
- "line-ne",
- 143,
- "143",
- "line-ne-open",
- 44,
- "44",
- "line-nw",
- 144,
- "144",
- "line-nw-open",
- 45,
- "45",
- "arrow-up",
- 145,
- "145",
- "arrow-up-open",
- 46,
- "46",
- "arrow-down",
- 146,
- "146",
- "arrow-down-open",
- 47,
- "47",
- "arrow-left",
- 147,
- "147",
- "arrow-left-open",
- 48,
- "48",
- "arrow-right",
- 148,
- "148",
- "arrow-right-open",
- 49,
- "49",
- "arrow-bar-up",
- 149,
- "149",
- "arrow-bar-up-open",
- 50,
- "50",
- "arrow-bar-down",
- 150,
- "150",
- "arrow-bar-down-open",
- 51,
- "51",
- "arrow-bar-left",
- 151,
- "151",
- "arrow-bar-left-open",
- 52,
- "52",
- "arrow-bar-right",
- 152,
- "152",
- "arrow-bar-right-open",
- 53,
- "53",
- "arrow",
- 153,
- "153",
- "arrow-open",
- 54,
- "54",
- "arrow-wide",
- 154,
- "154",
- "arrow-wide-open"
- ]
- },
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "meta": {
- "arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
- "mode": {
- "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.",
- "dflt": "markers",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "lines",
- "markers",
- "text"
- ],
- "valType": "flaglist"
- },
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "selected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of selected points.",
- "editType": "style",
- "valType": "color"
},
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "calc",
+ "valType": "data_array"
},
- "role": "object",
- "size": {
- "description": "Sets the marker size of selected points.",
- "editType": "style",
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
"min": 0,
"valType": "number"
- }
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of selected points.",
- "editType": "style",
- "valType": "color"
},
- "editType": "style",
- "role": "object"
- }
- },
- "selectedpoints": {
- "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
- "editType": "calc",
- "valType": "any"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean"
- },
- "stream": {
- "editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "calc",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
},
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
- },
- "text": {
- "arrayOk": true,
- "description": "Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "style",
- "valType": "color"
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
},
"colorsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
"valType": "string"
},
- "description": "Sets the text font.",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "dash": {
+ "description": "Sets the dash style of the lines.",
+ "dflt": "solid",
"editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "dash",
+ "dashdot",
+ "dot",
+ "longdash",
+ "longdashdot",
+ "solid"
+ ]
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
+ "editType": "calc",
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `line.color` is set to a numerical array. If true, `line.cmin` will correspond to the last color in the array and `line.cmax` will correspond to the first color.",
+ "dflt": false,
"editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "valType": "boolean"
},
"role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `line.color` is set to a numerical array.",
+ "dflt": false,
"editType": "calc",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "valType": "boolean"
},
- "size": {
- "arrayOk": true,
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
"editType": "calc",
- "min": 1,
+ "min": 0,
"valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
+ }
+ },
+ "marker": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
+ "dflt": true,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
+ "impliedEdits": {},
+ "valType": "boolean"
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
+ "dflt": null,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
+ "impliedEdits": {},
+ "valType": "number"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
},
- "weight": {
+ "color": {
"arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
"editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "textposition": {
- "arrayOk": true,
- "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
- "dflt": "middle center",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "top left",
- "top center",
- "top right",
- "middle left",
- "middle center",
- "middle right",
- "bottom left",
- "bottom center",
- "bottom right"
- ]
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `a`, `b` and `text`.",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
+ "valType": "color"
},
- "role": "object"
- },
- "type": "scattercarpet",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "unselected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color"
- },
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of unselected points, applied only when a selection exists.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- }
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
},
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color"
- },
- "editType": "style",
- "role": "object"
- }
- },
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- true,
- false,
- "legendonly"
- ]
- },
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "zorder": {
- "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
- "dflt": 0,
- "editType": "plot",
- "valType": "integer"
- }
- },
- "categories": [
- "svg",
- "carpet",
- "symbols",
- "showLegend",
- "carpetDependent",
- "zoomScale"
- ],
- "meta": {
- "description": "Plots a scatter trace on either the first carpet axis or the carpet axis with a matching `carpet` attribute.",
- "hrName": "scatter_carpet"
- },
- "type": "scattercarpet"
- },
- "scattergeo": {
- "animatable": false,
- "attributes": {
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "customdata": {
- "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
- "editType": "calc",
- "valType": "data_array"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "featureidkey": {
- "description": "Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example *properties.name*.",
- "dflt": "id",
- "editType": "calc",
- "valType": "string"
- },
- "fill": {
- "description": "Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.",
- "dflt": "none",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "toself"
- ]
- },
- "fillcolor": {
- "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.",
- "editType": "calc",
- "valType": "color"
- },
- "geo": {
- "description": "Sets a reference between this trace's geospatial coordinates and a geographic map. If *geo* (the default value), the geospatial coordinates refer to `layout.geo`. If *geo2*, the geospatial coordinates refer to `layout.geo2`, and so on.",
- "dflt": "geo",
- "editType": "calc",
- "valType": "subplotid"
- },
- "geojson": {
- "description": "Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when `locations` is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*.",
- "editType": "calc",
- "valType": "any"
- },
- "hoverinfo": {
- "arrayOk": true,
- "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
- "dflt": "all",
- "editType": "calc",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "lon",
- "lat",
- "location",
- "text",
- "name"
- ],
- "valType": "flaglist"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "hoverlabel": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
- "dflt": "auto",
- "editType": "none",
- "valType": "enumerated",
- "values": [
- "left",
- "right",
- "auto"
- ]
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
- },
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
},
- "description": "Sets the font used in hover labels.",
- "editType": "none",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string"
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
},
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "none",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "editType": "calc",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "any"
},
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "none",
- "valType": "string"
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
},
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "calc",
+ "min": 0,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "h",
+ "v"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
},
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "none",
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "all",
+ "first",
+ "last",
+ "none"
]
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "namelength": {
- "arrayOk": true,
- "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
- "dflt": 15,
- "editType": "none",
- "min": -1,
- "valType": "integer"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object"
- },
- "hovertemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Sets hover text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
- },
- "ids": {
- "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
- "editType": "calc",
- "valType": "data_array"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "lat": {
- "description": "Sets the latitude coordinates (in degrees North).",
- "editType": "calc",
- "valType": "data_array"
- },
- "latsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
- "editType": "none",
- "valType": "string"
- },
- "legend": {
- "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
- "dflt": "legend",
- "editType": "style",
- "valType": "subplotid"
- },
- "legendgroup": {
- "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "calc",
"valType": "color"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
+ "tickfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "calc",
"valType": "string"
},
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "style",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "any"
+ },
+ {
+ "editType": "calc",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "calc",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
},
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "style",
- "valType": "string"
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
},
- "size": {
- "editType": "style",
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "calc",
"min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
"valType": "number"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "calc",
+ "impliedEdits": {},
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "auto",
+ "linear",
+ "array"
]
},
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "style",
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "outside",
+ "inside",
+ ""
]
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "calc",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "left",
+ "center",
+ "right"
]
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string"
- }
- },
- "legendrank": {
- "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
- "dflt": 1000,
- "editType": "style",
- "valType": "number"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number"
- },
- "line": {
- "color": {
- "description": "Sets the line color.",
- "editType": "calc",
- "valType": "color"
- },
- "dash": {
- "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
- "dflt": "solid",
- "editType": "calc",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ]
- },
- "editType": "calc",
- "role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- }
- },
- "locationmode": {
- "description": "Determines the set of locations used to match entries in `locations` to regions on the map. Values *ISO-3*, *USA-states*, *country names* correspond to features on the base map and value *geojson-id* corresponds to features from a custom GeoJSON linked to the `geojson` attribute.",
- "dflt": "ISO-3",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "ISO-3",
- "USA-states",
- "country names",
- "geojson-id"
- ]
- },
- "locations": {
- "description": "Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.",
- "editType": "calc",
- "valType": "data_array"
- },
- "locationssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
- "editType": "none",
- "valType": "string"
- },
- "lon": {
- "description": "Sets the longitude coordinates (in degrees East).",
- "editType": "calc",
- "valType": "data_array"
- },
- "lonsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
- "editType": "none",
- "valType": "string"
- },
- "marker": {
- "angle": {
- "arrayOk": true,
- "description": "Sets the marker angle in respect to `angleref`.",
- "dflt": 0,
- "editType": "calc",
- "valType": "angle"
- },
- "angleref": {
- "description": "Sets the reference for marker angle. With *previous*, angle 0 points along the line from the previous point to this one. With *up*, angle 0 points toward the top of the screen. With *north*, angle 0 points north based on the current map projection.",
- "dflt": "up",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "previous",
- "up",
- "north"
- ]
- },
- "anglesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
- "editType": "none",
- "valType": "string"
- },
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "color": {
- "arrayOk": true,
- "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
- "editType": "calc",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorbar": {
- "_deprecated": {
- "title": {
- "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "calc",
- "valType": "string"
- },
- "titlefont": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "titleside": {
- "description": "Deprecated in favor of color bar's `title.side`.",
- "dflt": "top",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- }
- },
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "calc",
- "valType": "color"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
"editType": "calc",
"min": 0,
"valType": "number"
},
- "dtick": {
- "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "calc",
- "impliedEdits": {
- "tickmode": "linear"
- },
- "valType": "any"
- },
- "editType": "calc",
- "exponentformat": {
- "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
- "dflt": "B",
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
"editType": "calc",
"valType": "enumerated",
"values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B"
+ "container",
+ "paper"
]
},
- "labelalias": {
- "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
- "dflt": false,
- "editType": "calc",
- "valType": "any"
- },
- "len": {
- "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
- "dflt": 1,
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
"editType": "calc",
- "min": 0,
"valType": "number"
},
- "lenmode": {
- "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
- "dflt": "fraction",
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
"editType": "calc",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "top",
+ "middle",
+ "bottom"
]
},
- "minexponent": {
- "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
- "dflt": 3,
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
"editType": "calc",
"min": 0,
"valType": "number"
},
- "nticks": {
- "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
"editType": "calc",
"valType": "enumerated",
"values": [
- "h",
- "v"
+ "container",
+ "paper"
]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
"editType": "calc",
+ "impliedEdits": {},
"valType": "boolean"
},
- "showexponent": {
- "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
- "dflt": "all",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
"dflt": true,
"editType": "calc",
+ "impliedEdits": {},
"valType": "boolean"
},
- "showtickprefix": {
- "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
- "dflt": "all",
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
+ "dflt": null,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
+ "dflt": null,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ]
+ "impliedEdits": {},
+ "valType": "number"
},
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
+ "dflt": null,
"editType": "calc",
- "min": 0,
+ "impliedEdits": {
+ "cauto": false
+ },
"valType": "number"
},
- "thicknessmode": {
- "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
- "dflt": "pixels",
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
- ]
+ "valType": "color"
},
- "tick0": {
- "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
"editType": "calc",
"impliedEdits": {
- "tickmode": "linear"
+ "autocolorscale": false
},
- "valType": "any"
+ "valType": "colorscale"
},
- "tickangle": {
- "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
- "dflt": "auto",
- "editType": "calc",
- "valType": "angle"
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
+ "editType": "calc",
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
+ "dflt": false,
"editType": "calc",
- "valType": "color"
+ "valType": "boolean"
},
- "tickfont": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Sets the color bar's tick label font",
+ "role": "object",
+ "width": {
+ "arrayOk": false,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
"editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "tickformat": {
- "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "tickformatstops": {
- "items": {
- "tickformatstop": {
- "dtickrange": {
- "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "valType": "any"
- },
- {
- "editType": "calc",
- "valType": "any"
- }
- ],
- "valType": "info_array"
- },
- "editType": "calc",
- "enabled": {
- "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean"
- },
- "name": {
- "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "calc",
- "valType": "string"
- },
- "role": "object",
- "templateitemname": {
- "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
- "valType": "string"
- },
- "value": {
- "description": "string - dtickformat for described zoom level, the same as *tickformat*",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- }
- }
- },
- "role": "object"
- },
- "ticklabeloverflow": {
- "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "allow",
- "hide past div",
- "hide past domain"
- ]
- },
- "ticklabelposition": {
- "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
- "dflt": "outside",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
- ]
- },
- "ticklabelstep": {
- "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "opacity": {
+ "arrayOk": false,
+ "description": "Sets the marker opacity. Note that the marker opacity for scatter3d traces must be a scalar value for performance reasons. To set a blending opacity value (i.e. which is not transparent), set *marker.color* to an rgba color and use its alpha channel.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the marker size (in px).",
+ "dflt": 8,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemin": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemode": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
+ "dflt": "diameter",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "diameter",
+ "area"
+ ]
+ },
+ "sizeref": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "symbol": {
+ "arrayOk": true,
+ "description": "Sets the marker symbol type.",
+ "dflt": "circle",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "circle",
+ "circle-open",
+ "cross",
+ "diamond",
+ "diamond-open",
+ "square",
+ "square-open",
+ "x"
+ ]
+ },
+ "symbolsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "mode": {
+ "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.",
+ "dflt": "lines+markers",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "lines",
+ "markers",
+ "text"
+ ],
+ "valType": "flaglist"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "projection": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
+ "editType": "calc",
+ "opacity": {
+ "description": "Sets the projection color.",
"dflt": 1,
"editType": "calc",
- "min": 1,
- "valType": "integer"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "calc",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "tickmode": {
- "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "calc",
- "impliedEdits": {},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ]
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "ticks": {
- "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
- "dflt": "",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "outside",
- "inside",
- ""
- ]
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "ticktext": {
- "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "role": "object",
+ "scale": {
+ "description": "Sets the scale factor determining the size of the projection marker points.",
+ "dflt": 0.6666666666666666,
"editType": "calc",
- "valType": "data_array"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "max": 10,
+ "min": 0,
+ "valType": "number"
},
- "tickvals": {
- "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "show": {
+ "description": "Sets whether or not projections are shown along the x axis.",
+ "dflt": false,
"editType": "calc",
- "valType": "data_array"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
- "tickwidth": {
- "description": "Sets the tick width (in px).",
+ "valType": "boolean"
+ }
+ },
+ "y": {
+ "editType": "calc",
+ "opacity": {
+ "description": "Sets the projection color.",
"dflt": 1,
"editType": "calc",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "title": {
- "editType": "calc",
- "font": {
- "color": {
- "editType": "calc",
- "valType": "color"
- },
- "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "calc",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "lineposition": {
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "role": "object",
- "shadow": {
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "textcase": {
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- }
- },
- "role": "object",
- "side": {
- "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ]
- },
- "text": {
- "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "calc",
- "valType": "string"
- }
- },
- "x": {
- "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "role": "object",
+ "scale": {
+ "description": "Sets the scale factor determining the size of the projection marker points.",
+ "dflt": 0.6666666666666666,
"editType": "calc",
+ "max": 10,
+ "min": 0,
"valType": "number"
},
- "xanchor": {
- "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "show": {
+ "description": "Sets whether or not projections are shown along the y axis.",
+ "dflt": false,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ]
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
+ "valType": "boolean"
+ }
+ },
+ "z": {
+ "editType": "calc",
+ "opacity": {
+ "description": "Sets the projection color.",
+ "dflt": 1,
"editType": "calc",
+ "max": 1,
"min": 0,
"valType": "number"
},
- "xref": {
- "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
- "dflt": "paper",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
- },
- "y": {
- "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "role": "object",
+ "scale": {
+ "description": "Sets the scale factor determining the size of the projection marker points.",
+ "dflt": 0.6666666666666666,
"editType": "calc",
+ "max": 10,
+ "min": 0,
"valType": "number"
},
- "yanchor": {
- "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "top",
- "middle",
- "bottom"
- ]
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "yref": {
- "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
- "dflt": "paper",
+ "show": {
+ "description": "Sets whether or not projections are shown along the z axis.",
+ "dflt": false,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ]
+ "valType": "boolean"
}
+ }
+ },
+ "scene": {
+ "description": "Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.",
+ "dflt": "scene",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
},
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
"editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "surfaceaxis": {
+ "description": "If *-1*, the scatter points are not fill with a surface If *0*, *1*, *2*, the scatter points are filled with a Delaunay surface about the x, y, z respectively.",
+ "dflt": -1,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ -1,
+ 0,
+ 1,
+ 2
+ ]
+ },
+ "surfacecolor": {
+ "description": "Sets the surface fill color.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "text": {
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "calc",
+ "valType": "color"
},
"colorsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `color`.",
"editType": "none",
"valType": "string"
},
+ "description": "Sets the text font.",
"editType": "calc",
- "gradient": {
- "color": {
- "arrayOk": true,
- "description": "Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.",
- "editType": "calc",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "role": "object",
- "type": {
- "arrayOk": true,
- "description": "Sets the type of gradient used to fill the markers",
- "dflt": "none",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "radial",
- "horizontal",
- "vertical",
- "none"
- ]
- },
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "line": {
- "autocolorscale": {
- "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
- "dflt": true,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "boolean"
- },
- "cmax": {
- "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "cmid": {
- "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {},
- "valType": "number"
- },
- "cmin": {
- "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false
- },
- "valType": "number"
- },
- "color": {
- "arrayOk": true,
- "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
- "editType": "calc",
- "valType": "color"
- },
- "coloraxis": {
- "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
- "dflt": null,
- "editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid"
- },
- "colorscale": {
- "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "autocolorscale": false
- },
- "valType": "colorscale"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
- "role": "object",
- "width": {
- "arrayOk": true,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "opacity": {
+ "family": {
"arrayOk": true,
- "description": "Sets the marker opacity.",
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
"editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
},
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
"editType": "none",
"valType": "string"
},
- "reversescale": {
- "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
"role": "object",
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean"
- },
"size": {
"arrayOk": true,
- "description": "Sets the marker size (in px).",
- "dflt": 6,
"editType": "calc",
- "min": 0,
+ "min": 1,
"valType": "number"
},
- "sizemin": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number"
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
},
- "sizemode": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
- "dflt": "diameter",
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "calc",
"valType": "enumerated",
"values": [
- "diameter",
- "area"
+ "normal",
+ "italic"
]
},
- "sizeref": {
- "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
"editType": "none",
"valType": "string"
},
- "standoff": {
+ "variant": {
"arrayOk": true,
- "description": "Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.",
- "dflt": 0,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "calc",
- "min": 0,
- "valType": "number"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps"
+ ]
},
- "standoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `standoff`.",
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
"editType": "none",
"valType": "string"
},
- "symbol": {
+ "weight": {
"arrayOk": true,
- "description": "Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name.",
- "dflt": "circle",
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- 0,
- "0",
- "circle",
- 100,
- "100",
- "circle-open",
- 200,
- "200",
- "circle-dot",
- 300,
- "300",
- "circle-open-dot",
- 1,
- "1",
- "square",
- 101,
- "101",
- "square-open",
- 201,
- "201",
- "square-dot",
- 301,
- "301",
- "square-open-dot",
- 2,
- "2",
- "diamond",
- 102,
- "102",
- "diamond-open",
- 202,
- "202",
- "diamond-dot",
- 302,
- "302",
- "diamond-open-dot",
- 3,
- "3",
- "cross",
- 103,
- "103",
- "cross-open",
- 203,
- "203",
- "cross-dot",
- 303,
- "303",
- "cross-open-dot",
- 4,
- "4",
- "x",
- 104,
- "104",
- "x-open",
- 204,
- "204",
- "x-dot",
- 304,
- "304",
- "x-open-dot",
- 5,
- "5",
- "triangle-up",
- 105,
- "105",
- "triangle-up-open",
- 205,
- "205",
- "triangle-up-dot",
- 305,
- "305",
- "triangle-up-open-dot",
- 6,
- "6",
- "triangle-down",
- 106,
- "106",
- "triangle-down-open",
- 206,
- "206",
- "triangle-down-dot",
- 306,
- "306",
- "triangle-down-open-dot",
- 7,
- "7",
- "triangle-left",
- 107,
- "107",
- "triangle-left-open",
- 207,
- "207",
- "triangle-left-dot",
- 307,
- "307",
- "triangle-left-open-dot",
- 8,
- "8",
- "triangle-right",
- 108,
- "108",
- "triangle-right-open",
- 208,
- "208",
- "triangle-right-dot",
- 308,
- "308",
- "triangle-right-open-dot",
- 9,
- "9",
- "triangle-ne",
- 109,
- "109",
- "triangle-ne-open",
- 209,
- "209",
- "triangle-ne-dot",
- 309,
- "309",
- "triangle-ne-open-dot",
- 10,
- "10",
- "triangle-se",
- 110,
- "110",
- "triangle-se-open",
- 210,
- "210",
- "triangle-se-dot",
- 310,
- "310",
- "triangle-se-open-dot",
- 11,
- "11",
- "triangle-sw",
- 111,
- "111",
- "triangle-sw-open",
- 211,
- "211",
- "triangle-sw-dot",
- 311,
- "311",
- "triangle-sw-open-dot",
- 12,
- "12",
- "triangle-nw",
- 112,
- "112",
- "triangle-nw-open",
- 212,
- "212",
- "triangle-nw-dot",
- 312,
- "312",
- "triangle-nw-open-dot",
- 13,
- "13",
- "pentagon",
- 113,
- "113",
- "pentagon-open",
- 213,
- "213",
- "pentagon-dot",
- 313,
- "313",
- "pentagon-open-dot",
- 14,
- "14",
- "hexagon",
- 114,
- "114",
- "hexagon-open",
- 214,
- "214",
- "hexagon-dot",
- 314,
- "314",
- "hexagon-open-dot",
- 15,
- "15",
- "hexagon2",
- 115,
- "115",
- "hexagon2-open",
- 215,
- "215",
- "hexagon2-dot",
- 315,
- "315",
- "hexagon2-open-dot",
- 16,
- "16",
- "octagon",
- 116,
- "116",
- "octagon-open",
- 216,
- "216",
- "octagon-dot",
- 316,
- "316",
- "octagon-open-dot",
- 17,
- "17",
- "star",
- 117,
- "117",
- "star-open",
- 217,
- "217",
- "star-dot",
- 317,
- "317",
- "star-open-dot",
- 18,
- "18",
- "hexagram",
- 118,
- "118",
- "hexagram-open",
- 218,
- "218",
- "hexagram-dot",
- 318,
- "318",
- "hexagram-open-dot",
- 19,
- "19",
- "star-triangle-up",
- 119,
- "119",
- "star-triangle-up-open",
- 219,
- "219",
- "star-triangle-up-dot",
- 319,
- "319",
- "star-triangle-up-open-dot",
- 20,
- "20",
- "star-triangle-down",
- 120,
- "120",
- "star-triangle-down-open",
- 220,
- "220",
- "star-triangle-down-dot",
- 320,
- "320",
- "star-triangle-down-open-dot",
- 21,
- "21",
- "star-square",
- 121,
- "121",
- "star-square-open",
- 221,
- "221",
- "star-square-dot",
- 321,
- "321",
- "star-square-open-dot",
- 22,
- "22",
- "star-diamond",
- 122,
- "122",
- "star-diamond-open",
- 222,
- "222",
- "star-diamond-dot",
- 322,
- "322",
- "star-diamond-open-dot",
- 23,
- "23",
- "diamond-tall",
- 123,
- "123",
- "diamond-tall-open",
- 223,
- "223",
- "diamond-tall-dot",
- 323,
- "323",
- "diamond-tall-open-dot",
- 24,
- "24",
- "diamond-wide",
- 124,
- "124",
- "diamond-wide-open",
- 224,
- "224",
- "diamond-wide-dot",
- 324,
- "324",
- "diamond-wide-open-dot",
- 25,
- "25",
- "hourglass",
- 125,
- "125",
- "hourglass-open",
- 26,
- "26",
- "bowtie",
- 126,
- "126",
- "bowtie-open",
- 27,
- "27",
- "circle-cross",
- 127,
- "127",
- "circle-cross-open",
- 28,
- "28",
- "circle-x",
- 128,
- "128",
- "circle-x-open",
- 29,
- "29",
- "square-cross",
- 129,
- "129",
- "square-cross-open",
- 30,
- "30",
- "square-x",
- 130,
- "130",
- "square-x-open",
- 31,
- "31",
- "diamond-cross",
- 131,
- "131",
- "diamond-cross-open",
- 32,
- "32",
- "diamond-x",
- 132,
- "132",
- "diamond-x-open",
- 33,
- "33",
- "cross-thin",
- 133,
- "133",
- "cross-thin-open",
- 34,
- "34",
- "x-thin",
- 134,
- "134",
- "x-thin-open",
- 35,
- "35",
- "asterisk",
- 135,
- "135",
- "asterisk-open",
- 36,
- "36",
- "hash",
- 136,
- "136",
- "hash-open",
- 236,
- "236",
- "hash-dot",
- 336,
- "336",
- "hash-open-dot",
- 37,
- "37",
- "y-up",
- 137,
- "137",
- "y-up-open",
- 38,
- "38",
- "y-down",
- 138,
- "138",
- "y-down-open",
- 39,
- "39",
- "y-left",
- 139,
- "139",
- "y-left-open",
- 40,
- "40",
- "y-right",
- 140,
- "140",
- "y-right-open",
- 41,
- "41",
- "line-ew",
- 141,
- "141",
- "line-ew-open",
- 42,
- "42",
- "line-ns",
- 142,
- "142",
- "line-ns-open",
- 43,
- "43",
- "line-ne",
- 143,
- "143",
- "line-ne-open",
- 44,
- "44",
- "line-nw",
- 144,
- "144",
- "line-nw-open",
- 45,
- "45",
- "arrow-up",
- 145,
- "145",
- "arrow-up-open",
- 46,
- "46",
- "arrow-down",
- 146,
- "146",
- "arrow-down-open",
- 47,
- "47",
- "arrow-left",
- 147,
- "147",
- "arrow-left-open",
- 48,
- "48",
- "arrow-right",
- 148,
- "148",
- "arrow-right-open",
- 49,
- "49",
- "arrow-bar-up",
- 149,
- "149",
- "arrow-bar-up-open",
- 50,
- "50",
- "arrow-bar-down",
- 150,
- "150",
- "arrow-bar-down-open",
- 51,
- "51",
- "arrow-bar-left",
- 151,
- "151",
- "arrow-bar-left-open",
- 52,
- "52",
- "arrow-bar-right",
- 152,
- "152",
- "arrow-bar-right-open",
- 53,
- "53",
- "arrow",
- 153,
- "153",
- "arrow-open",
- 54,
- "54",
- "arrow-wide",
- 154,
- "154",
- "arrow-wide-open"
- ]
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
"editType": "none",
"valType": "string"
}
},
- "meta": {
+ "textposition": {
"arrayOk": true,
- "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
- "editType": "plot",
- "valType": "any"
+ "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
+ "dflt": "top center",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle left",
+ "middle center",
+ "middle right",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ]
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "textpositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
"editType": "none",
"valType": "string"
},
- "mode": {
- "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.",
- "dflt": "markers",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "lines",
- "markers",
- "text"
- ],
- "valType": "flaglist"
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
},
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
+ "dflt": "",
+ "editType": "calc",
"valType": "string"
},
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "editType": "none",
+ "valType": "string"
},
- "selected": {
- "editType": "calc",
- "marker": {
- "color": {
- "description": "Sets the marker color of selected points.",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of selected points.",
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
"editType": "calc",
- "min": 0,
- "valType": "number"
+ "role": "object"
}
},
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of selected points.",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object"
- }
+ "role": "object"
},
- "selectedpoints": {
- "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
- "editType": "calc",
+ "type": "scatter3d",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
"valType": "any"
},
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
"dflt": true,
- "editType": "style",
- "valType": "boolean"
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
},
- "stream": {
+ "x": {
+ "description": "Sets the x coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
"editType": "calc",
- "maxpoints": {
- "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
- "dflt": 500,
- "editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "token": {
- "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- }
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
},
- "text": {
- "arrayOk": true,
- "description": "Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
"dflt": "",
"editType": "calc",
"valType": "string"
},
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "calc",
- "valType": "color"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the text font.",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
- "lineposition": {
- "arrayOk": true,
- "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
- "dflt": "none",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "under",
- "over",
- "through"
- ],
- "valType": "flaglist"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "shadow": {
- "arrayOk": true,
- "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
- "dflt": "none",
- "editType": "calc",
- "valType": "string"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
- "size": {
- "arrayOk": true,
- "editType": "calc",
- "min": 1,
- "valType": "number"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "italic"
- ]
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "textcase": {
- "arrayOk": true,
- "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ]
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- }
- },
- "textposition": {
- "arrayOk": true,
- "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
- "dflt": "middle center",
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "y": {
+ "description": "Sets the y coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
"editType": "calc",
"valType": "enumerated",
"values": [
- "top left",
- "top center",
- "top right",
- "middle left",
- "middle center",
- "middle right",
- "bottom left",
- "bottom center",
- "bottom right"
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
]
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `lat`, `lon`, `location` and `text`.",
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
"dflt": "",
"editType": "calc",
"valType": "string"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
"editType": "none",
"valType": "string"
},
- "transforms": {
- "items": {
- "transform": {
- "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
- "editType": "calc",
- "role": "object"
- }
- },
- "role": "object"
- },
- "type": "scattergeo",
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string"
- },
- "uirevision": {
- "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
- "editType": "none",
- "valType": "any"
- },
- "unselected": {
- "editType": "calc",
- "marker": {
- "color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "opacity": {
- "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of unselected points, applied only when a selection exists.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- }
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of unselected points, applied only when a selection exists.",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object"
- }
+ "z": {
+ "description": "Sets the z coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
},
- "visible": {
- "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
- "dflt": true,
+ "zcalendar": {
+ "description": "Sets the calendar system to use with `z` date data.",
+ "dflt": "gregorian",
"editType": "calc",
"valType": "enumerated",
"values": [
- true,
- false,
- "legendonly"
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
]
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rulefor `z` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `zaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "zsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `z`.",
+ "editType": "none",
+ "valType": "string"
}
},
"categories": [
- "geo",
+ "gl3d",
"symbols",
"showLegend",
"scatter-like"
],
"meta": {
- "description": "The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in `lon` and `lat` respectively or by geographic location IDs or names in `locations`.",
- "hrName": "scatter_geo"
+ "description": "The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.",
+ "hrName": "scatter_3d"
},
- "type": "scattergeo"
+ "type": "scatter3d"
},
- "scattergl": {
+ "scattercarpet": {
"animatable": false,
"attributes": {
+ "a": {
+ "description": "Sets the a-axis coordinates.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "asrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `a`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "b": {
+ "description": "Sets the b-axis coordinates.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "bsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `b`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "carpet": {
+ "description": "An identifier for this carpet, so that `scattercarpet` and `contourcarpet` traces can specify a carpet plot on which they lie",
+ "editType": "calc",
+ "valType": "string"
+ },
"connectgaps": {
"description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
"dflt": false,
@@ -71594,232 +69959,20 @@
"editType": "none",
"valType": "string"
},
- "dx": {
- "description": "Sets the x coordinate step. See `x0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "dy": {
- "description": "Sets the y coordinate step. See `y0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number"
- },
- "error_x": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "calc",
- "valType": "number"
- }
- },
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
- "editType": "none",
- "valType": "string"
- },
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
- "editType": "none",
- "valType": "string"
- },
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "calc",
- "valType": "color"
- },
- "copy_ystyle": {
- "editType": "calc",
- "valType": "boolean"
- },
- "editType": "calc",
- "role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "traceref": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "percent",
- "constant",
- "sqrt",
- "data"
- ]
- },
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- }
- },
- "error_y": {
- "_deprecated": {
- "opacity": {
- "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
- "editType": "calc",
- "valType": "number"
- }
- },
- "array": {
- "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminus": {
- "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
- "editType": "calc",
- "valType": "data_array"
- },
- "arrayminussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
- "editType": "none",
- "valType": "string"
- },
- "arraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `array`.",
- "editType": "none",
- "valType": "string"
- },
- "color": {
- "description": "Sets the stoke color of the error bars.",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object",
- "symmetric": {
- "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
- "editType": "calc",
- "valType": "boolean"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "traceref": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer"
- },
- "type": {
- "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "percent",
- "constant",
- "sqrt",
- "data"
- ]
- },
- "value": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "valueminus": {
- "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "calc",
- "min": 0,
- "valType": "number"
- }
- },
"fill": {
- "description": "Sets the area to fill with a solid color. Defaults to *none* unless this trace is stacked, then it gets *tonexty* (*tonextx*) if `orientation` is *v* (*h*) Use with `fillcolor` if not *none*. *tozerox* and *tozeroy* fill to x=0 and y=0 respectively. *tonextx* and *tonexty* fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like *tozerox* and *tozeroy*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. *tonext* fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like *toself* if there is no trace before it. *tonext* should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.",
+ "description": "Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. scatterternary has a subset of the options available to scatter. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. *tonext* fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like *toself* if there is no trace before it. *tonext* should not be used if one trace does not enclose the other.",
"dflt": "none",
"editType": "calc",
"valType": "enumerated",
"values": [
"none",
- "tozeroy",
- "tozerox",
- "tonexty",
- "tonextx",
"toself",
"tonext"
]
},
"fillcolor": {
"description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.",
- "editType": "calc",
+ "editType": "style",
"valType": "color"
},
"hoverinfo": {
@@ -71833,9 +69986,8 @@
"skip"
],
"flags": [
- "x",
- "y",
- "z",
+ "a",
+ "b",
"text",
"name"
],
@@ -72045,6 +70197,15 @@
},
"role": "object"
},
+ "hoveron": {
+ "description": "Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is *toself* or *tonext* and there are no markers or text, then the default is *fills*, otherwise it is *points*.",
+ "editType": "style",
+ "flags": [
+ "points",
+ "fills"
+ ],
+ "valType": "flaglist"
+ },
"hovertemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
@@ -72059,9 +70220,9 @@
},
"hovertext": {
"arrayOk": true,
- "description": "Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "description": "Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace `hoverinfo` must contain a *text* flag.",
"dflt": "",
- "editType": "calc",
+ "editType": "style",
"valType": "string"
},
"hovertextsrc": {
@@ -72203,44 +70364,62 @@
"valType": "number"
},
"line": {
+ "backoff": {
+ "arrayOk": true,
+ "description": "Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With *auto* the lines would trim before markers if `marker.angleref` is set to *previous*.",
+ "dflt": "auto",
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
+ "backoffsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
+ "editType": "none",
+ "valType": "string"
+ },
"color": {
"description": "Sets the line color.",
- "editType": "calc",
+ "editType": "style",
"valType": "color"
},
"dash": {
- "description": "Sets the style of the lines.",
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
"dflt": "solid",
- "editType": "calc",
- "valType": "enumerated",
+ "editType": "style",
+ "valType": "string",
"values": [
- "dash",
- "dashdot",
+ "solid",
"dot",
+ "dash",
"longdash",
- "longdashdot",
- "solid"
+ "dashdot",
+ "longdashdot"
]
},
"editType": "calc",
"role": "object",
"shape": {
- "description": "Determines the line shape. The values correspond to step-wise line shapes.",
+ "description": "Determines the line shape. With *spline* the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.",
"dflt": "linear",
- "editType": "calc",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"linear",
- "hv",
- "vh",
- "hvh",
- "vhv"
+ "spline"
]
},
+ "smoothing": {
+ "description": "Has an effect only if `shape` is set to *spline* Sets the amount of smoothing. *0* corresponds to no smoothing (equivalent to a *linear* shape).",
+ "dflt": 1,
+ "editType": "plot",
+ "max": 1.3,
+ "min": 0,
+ "valType": "number"
+ },
"width": {
"description": "Sets the line width (in px).",
"dflt": 2,
- "editType": "calc",
+ "editType": "style",
"min": 0,
"valType": "number"
}
@@ -72250,9 +70429,19 @@
"arrayOk": true,
"description": "Sets the marker angle in respect to `angleref`.",
"dflt": 0,
- "editType": "calc",
+ "editType": "plot",
"valType": "angle"
},
+ "angleref": {
+ "description": "Sets the reference for marker angle. With *previous*, angle 0 points along the line from the previous point to this one. With *up*, angle 0 points toward the top of the screen.",
+ "dflt": "up",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "previous",
+ "up"
+ ]
+ },
"anglesrc": {
"description": "Sets the source reference on Chart Studio Cloud for `angle`.",
"editType": "none",
@@ -72275,7 +70464,7 @@
"cmax": {
"description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
"dflt": null,
- "editType": "calc",
+ "editType": "plot",
"impliedEdits": {
"cauto": false
},
@@ -72291,7 +70480,7 @@
"cmin": {
"description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
"dflt": null,
- "editType": "calc",
+ "editType": "plot",
"impliedEdits": {
"cauto": false
},
@@ -72300,7 +70489,7 @@
"color": {
"arrayOk": true,
"description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
- "editType": "calc",
+ "editType": "style",
"valType": "color"
},
"coloraxis": {
@@ -72314,19 +70503,19 @@
"_deprecated": {
"title": {
"description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"titlefont": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color"
},
"description": "Deprecated in favor of color bar's `title.font`.",
- "editType": "calc",
+ "editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -72334,7 +70523,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -72348,18 +70537,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72369,7 +70558,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72381,7 +70570,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72395,7 +70584,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -72408,7 +70597,7 @@
"titleside": {
"description": "Deprecated in favor of color bar's `title.side`.",
"dflt": "top",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"right",
@@ -72420,35 +70609,35 @@
"bgcolor": {
"description": "Sets the color of padded area.",
"dflt": "rgba(0,0,0,0)",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
"dflt": 0,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
"dtick": {
"description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
- "editType": "calc",
+ "editType": "colorbars",
"impliedEdits": {
"tickmode": "linear"
},
"valType": "any"
},
- "editType": "calc",
+ "editType": "colorbars",
"exponentformat": {
"description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
"dflt": "B",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"none",
@@ -72462,20 +70651,20 @@
"labelalias": {
"description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
"dflt": false,
- "editType": "calc",
+ "editType": "colorbars",
"valType": "any"
},
"len": {
"description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
"dflt": 1,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
"lenmode": {
"description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
"dflt": "fraction",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"fraction",
@@ -72485,21 +70674,21 @@
"minexponent": {
"description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
"dflt": 3,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
"nticks": {
"description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
"dflt": 0,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "integer"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
"dflt": "v",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"h",
@@ -72509,13 +70698,13 @@
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
"dflt": 1,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
@@ -72523,13 +70712,13 @@
"separatethousands": {
"description": "If \"true\", even 4-digit integers are separated",
"dflt": false,
- "editType": "calc",
+ "editType": "colorbars",
"valType": "boolean"
},
"showexponent": {
"description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
"dflt": "all",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"all",
@@ -72541,13 +70730,13 @@
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "calc",
+ "editType": "colorbars",
"valType": "boolean"
},
"showtickprefix": {
"description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
"dflt": "all",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"all",
@@ -72559,7 +70748,7 @@
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
"dflt": "all",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"all",
@@ -72571,14 +70760,14 @@
"thickness": {
"description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
"dflt": 30,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
"thicknessmode": {
"description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
"dflt": "pixels",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"fraction",
@@ -72587,7 +70776,7 @@
},
"tick0": {
"description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
- "editType": "calc",
+ "editType": "colorbars",
"impliedEdits": {
"tickmode": "linear"
},
@@ -72596,25 +70785,25 @@
"tickangle": {
"description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
"dflt": "auto",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "angle"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color"
},
"tickfont": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color"
},
"description": "Sets the color bar's tick label font",
- "editType": "calc",
+ "editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -72622,7 +70811,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -72637,18 +70826,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72658,7 +70847,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72670,7 +70859,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72684,7 +70873,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -72697,7 +70886,7 @@
"tickformat": {
"description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"tickformatstops": {
@@ -72705,41 +70894,41 @@
"tickformatstop": {
"dtickrange": {
"description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
- "editType": "calc",
+ "editType": "colorbars",
"items": [
{
- "editType": "calc",
+ "editType": "colorbars",
"valType": "any"
},
{
- "editType": "calc",
+ "editType": "colorbars",
"valType": "any"
}
],
"valType": "info_array"
},
- "editType": "calc",
+ "editType": "colorbars",
"enabled": {
"description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
"dflt": true,
- "editType": "calc",
+ "editType": "colorbars",
"valType": "boolean"
},
"name": {
"description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"role": "object",
"templateitemname": {
"description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"value": {
"description": "string - dtickformat for described zoom level, the same as *tickformat*",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
}
}
@@ -72748,7 +70937,7 @@
},
"ticklabeloverflow": {
"description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"allow",
@@ -72759,7 +70948,7 @@
"ticklabelposition": {
"description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
"dflt": "outside",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"outside",
@@ -72777,20 +70966,20 @@
"ticklabelstep": {
"description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
"dflt": 1,
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "integer"
},
"ticklen": {
"description": "Sets the tick length (in px).",
"dflt": 5,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
"tickmode": {
"description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
- "editType": "calc",
+ "editType": "colorbars",
"impliedEdits": {},
"valType": "enumerated",
"values": [
@@ -72802,13 +70991,13 @@
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"ticks": {
"description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"outside",
@@ -72819,12 +71008,12 @@
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"ticktext": {
"description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "data_array"
},
"ticktextsrc": {
@@ -72834,7 +71023,7 @@
},
"tickvals": {
"description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "data_array"
},
"tickvalssrc": {
@@ -72845,22 +71034,22 @@
"tickwidth": {
"description": "Sets the tick width (in px).",
"dflt": 1,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
"title": {
- "editType": "calc",
+ "editType": "colorbars",
"font": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color"
},
"description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
- "editType": "calc",
+ "editType": "colorbars",
"family": {
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string"
@@ -72868,7 +71057,7 @@
"lineposition": {
"description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"none"
],
@@ -72883,18 +71072,18 @@
"shadow": {
"description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
"dflt": "none",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72904,7 +71093,7 @@
"textcase": {
"description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72916,7 +71105,7 @@
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -72930,7 +71119,7 @@
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -72943,7 +71132,7 @@
"role": "object",
"side": {
"description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"right",
@@ -72953,18 +71142,18 @@
},
"text": {
"description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string"
}
},
"x": {
"description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "number"
},
"xanchor": {
"description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"left",
@@ -72975,14 +71164,14 @@
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
"dflt": 10,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
"xref": {
"description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
"dflt": "paper",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"container",
@@ -72991,12 +71180,12 @@
},
"y": {
"description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "number"
},
"yanchor": {
"description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"top",
@@ -73007,14 +71196,14 @@
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
"dflt": 10,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number"
},
"yref": {
"description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
"dflt": "paper",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"container",
@@ -73037,6 +71226,39 @@
"valType": "string"
},
"editType": "calc",
+ "gradient": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "role": "object",
+ "type": {
+ "arrayOk": true,
+ "description": "Sets the type of gradient used to fill the markers",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "radial",
+ "horizontal",
+ "vertical",
+ "none"
+ ]
+ },
+ "typesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `type`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
"line": {
"autocolorscale": {
"description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
@@ -73055,7 +71277,7 @@
"cmax": {
"description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
"dflt": null,
- "editType": "calc",
+ "editType": "plot",
"impliedEdits": {
"cauto": false
},
@@ -73071,7 +71293,7 @@
"cmin": {
"description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
"dflt": null,
- "editType": "calc",
+ "editType": "plot",
"impliedEdits": {
"cauto": false
},
@@ -73080,7 +71302,7 @@
"color": {
"arrayOk": true,
"description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
- "editType": "calc",
+ "editType": "style",
"valType": "color"
},
"coloraxis": {
@@ -73108,14 +71330,14 @@
"reversescale": {
"description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
"dflt": false,
- "editType": "calc",
+ "editType": "plot",
"valType": "boolean"
},
"role": "object",
"width": {
"arrayOk": true,
"description": "Sets the width (in px) of the lines bounding the marker points.",
- "editType": "calc",
+ "editType": "style",
"min": 0,
"valType": "number"
},
@@ -73125,10 +71347,17 @@
"valType": "string"
}
},
+ "maxdisplayed": {
+ "description": "Sets a maximum number of points to be drawn on the graph. *0* corresponds to no limit.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
"opacity": {
"arrayOk": true,
"description": "Sets the marker opacity.",
- "editType": "calc",
+ "editType": "style",
"max": 1,
"min": 0,
"valType": "number"
@@ -73141,7 +71370,7 @@
"reversescale": {
"description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
"dflt": false,
- "editType": "calc",
+ "editType": "plot",
"valType": "boolean"
},
"role": "object",
@@ -73187,11 +71416,24 @@
"editType": "none",
"valType": "string"
},
+ "standoff": {
+ "arrayOk": true,
+ "description": "Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number"
+ },
+ "standoffsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `standoff`.",
+ "editType": "none",
+ "valType": "string"
+ },
"symbol": {
"arrayOk": true,
"description": "Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name.",
"dflt": "circle",
- "editType": "calc",
+ "editType": "style",
"valType": "enumerated",
"values": [
0,
@@ -73700,7 +71942,6752 @@
"valType": "string"
},
"mode": {
- "description": "Determines the drawing mode for this scatter trace.",
+ "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.",
+ "dflt": "markers",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "lines",
+ "markers",
+ "text"
+ ],
+ "valType": "flaglist"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "selected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of selected points.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of selected points.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of selected points.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "role": "object"
+ }
+ },
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "text": {
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "style",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the text font.",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "textposition": {
+ "arrayOk": true,
+ "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
+ "dflt": "middle center",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle left",
+ "middle center",
+ "middle right",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ]
+ },
+ "textpositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `a`, `b` and `text`.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
+ "type": "scattercarpet",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "unselected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "opacity": {
+ "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color"
+ },
+ "editType": "style",
+ "role": "object"
+ }
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ },
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "zorder": {
+ "description": "Sets the layer on which this trace is displayed, relative to other SVG traces on the same subplot. SVG traces with higher `zorder` appear in front of those with lower `zorder`.",
+ "dflt": 0,
+ "editType": "plot",
+ "valType": "integer"
+ }
+ },
+ "categories": [
+ "svg",
+ "carpet",
+ "symbols",
+ "showLegend",
+ "carpetDependent",
+ "zoomScale"
+ ],
+ "meta": {
+ "description": "Plots a scatter trace on either the first carpet axis or the carpet axis with a matching `carpet` attribute.",
+ "hrName": "scatter_carpet"
+ },
+ "type": "scattercarpet"
+ },
+ "scattergeo": {
+ "animatable": false,
+ "attributes": {
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "featureidkey": {
+ "description": "Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example *properties.name*.",
+ "dflt": "id",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "fill": {
+ "description": "Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "toself"
+ ]
+ },
+ "fillcolor": {
+ "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "geo": {
+ "description": "Sets a reference between this trace's geospatial coordinates and a geographic map. If *geo* (the default value), the geospatial coordinates refer to `layout.geo`. If *geo2*, the geospatial coordinates refer to `layout.geo2`, and so on.",
+ "dflt": "geo",
+ "editType": "calc",
+ "valType": "subplotid"
+ },
+ "geojson": {
+ "description": "Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when `locations` is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "calc",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "lon",
+ "lat",
+ "location",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lat": {
+ "description": "Sets the latitude coordinates (in degrees North).",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "latsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "dash": {
+ "description": "Sets the dash style of lines. Set to a dash type string (*solid*, *dot*, *dash*, *longdash*, *dashdot*, or *longdashdot*) or a dash length list in px (eg *5px,10px,2px,2px*).",
+ "dflt": "solid",
+ "editType": "calc",
+ "valType": "string",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ]
+ },
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "locationmode": {
+ "description": "Determines the set of locations used to match entries in `locations` to regions on the map. Values *ISO-3*, *USA-states*, *country names* correspond to features on the base map and value *geojson-id* corresponds to features from a custom GeoJSON linked to the `geojson` attribute.",
+ "dflt": "ISO-3",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "ISO-3",
+ "USA-states",
+ "country names",
+ "geojson-id"
+ ]
+ },
+ "locations": {
+ "description": "Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "locationssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lon": {
+ "description": "Sets the longitude coordinates (in degrees East).",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "lonsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "marker": {
+ "angle": {
+ "arrayOk": true,
+ "description": "Sets the marker angle in respect to `angleref`.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "angle"
+ },
+ "angleref": {
+ "description": "Sets the reference for marker angle. With *previous*, angle 0 points along the line from the previous point to this one. With *up*, angle 0 points toward the top of the screen. With *north*, angle 0 points north based on the current map projection.",
+ "dflt": "up",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "previous",
+ "up",
+ "north"
+ ]
+ },
+ "anglesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "calc",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "any"
+ },
+ {
+ "editType": "calc",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "calc",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
+ },
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "calc",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "gradient": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "role": "object",
+ "type": {
+ "arrayOk": true,
+ "description": "Sets the type of gradient used to fill the markers",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "radial",
+ "horizontal",
+ "vertical",
+ "none"
+ ]
+ },
+ "typesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `type`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the marker opacity.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "opacitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the marker size (in px).",
+ "dflt": 6,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemin": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemode": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
+ "dflt": "diameter",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "diameter",
+ "area"
+ ]
+ },
+ "sizeref": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "standoff": {
+ "arrayOk": true,
+ "description": "Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "standoffsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `standoff`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "symbol": {
+ "arrayOk": true,
+ "description": "Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name.",
+ "dflt": "circle",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ 0,
+ "0",
+ "circle",
+ 100,
+ "100",
+ "circle-open",
+ 200,
+ "200",
+ "circle-dot",
+ 300,
+ "300",
+ "circle-open-dot",
+ 1,
+ "1",
+ "square",
+ 101,
+ "101",
+ "square-open",
+ 201,
+ "201",
+ "square-dot",
+ 301,
+ "301",
+ "square-open-dot",
+ 2,
+ "2",
+ "diamond",
+ 102,
+ "102",
+ "diamond-open",
+ 202,
+ "202",
+ "diamond-dot",
+ 302,
+ "302",
+ "diamond-open-dot",
+ 3,
+ "3",
+ "cross",
+ 103,
+ "103",
+ "cross-open",
+ 203,
+ "203",
+ "cross-dot",
+ 303,
+ "303",
+ "cross-open-dot",
+ 4,
+ "4",
+ "x",
+ 104,
+ "104",
+ "x-open",
+ 204,
+ "204",
+ "x-dot",
+ 304,
+ "304",
+ "x-open-dot",
+ 5,
+ "5",
+ "triangle-up",
+ 105,
+ "105",
+ "triangle-up-open",
+ 205,
+ "205",
+ "triangle-up-dot",
+ 305,
+ "305",
+ "triangle-up-open-dot",
+ 6,
+ "6",
+ "triangle-down",
+ 106,
+ "106",
+ "triangle-down-open",
+ 206,
+ "206",
+ "triangle-down-dot",
+ 306,
+ "306",
+ "triangle-down-open-dot",
+ 7,
+ "7",
+ "triangle-left",
+ 107,
+ "107",
+ "triangle-left-open",
+ 207,
+ "207",
+ "triangle-left-dot",
+ 307,
+ "307",
+ "triangle-left-open-dot",
+ 8,
+ "8",
+ "triangle-right",
+ 108,
+ "108",
+ "triangle-right-open",
+ 208,
+ "208",
+ "triangle-right-dot",
+ 308,
+ "308",
+ "triangle-right-open-dot",
+ 9,
+ "9",
+ "triangle-ne",
+ 109,
+ "109",
+ "triangle-ne-open",
+ 209,
+ "209",
+ "triangle-ne-dot",
+ 309,
+ "309",
+ "triangle-ne-open-dot",
+ 10,
+ "10",
+ "triangle-se",
+ 110,
+ "110",
+ "triangle-se-open",
+ 210,
+ "210",
+ "triangle-se-dot",
+ 310,
+ "310",
+ "triangle-se-open-dot",
+ 11,
+ "11",
+ "triangle-sw",
+ 111,
+ "111",
+ "triangle-sw-open",
+ 211,
+ "211",
+ "triangle-sw-dot",
+ 311,
+ "311",
+ "triangle-sw-open-dot",
+ 12,
+ "12",
+ "triangle-nw",
+ 112,
+ "112",
+ "triangle-nw-open",
+ 212,
+ "212",
+ "triangle-nw-dot",
+ 312,
+ "312",
+ "triangle-nw-open-dot",
+ 13,
+ "13",
+ "pentagon",
+ 113,
+ "113",
+ "pentagon-open",
+ 213,
+ "213",
+ "pentagon-dot",
+ 313,
+ "313",
+ "pentagon-open-dot",
+ 14,
+ "14",
+ "hexagon",
+ 114,
+ "114",
+ "hexagon-open",
+ 214,
+ "214",
+ "hexagon-dot",
+ 314,
+ "314",
+ "hexagon-open-dot",
+ 15,
+ "15",
+ "hexagon2",
+ 115,
+ "115",
+ "hexagon2-open",
+ 215,
+ "215",
+ "hexagon2-dot",
+ 315,
+ "315",
+ "hexagon2-open-dot",
+ 16,
+ "16",
+ "octagon",
+ 116,
+ "116",
+ "octagon-open",
+ 216,
+ "216",
+ "octagon-dot",
+ 316,
+ "316",
+ "octagon-open-dot",
+ 17,
+ "17",
+ "star",
+ 117,
+ "117",
+ "star-open",
+ 217,
+ "217",
+ "star-dot",
+ 317,
+ "317",
+ "star-open-dot",
+ 18,
+ "18",
+ "hexagram",
+ 118,
+ "118",
+ "hexagram-open",
+ 218,
+ "218",
+ "hexagram-dot",
+ 318,
+ "318",
+ "hexagram-open-dot",
+ 19,
+ "19",
+ "star-triangle-up",
+ 119,
+ "119",
+ "star-triangle-up-open",
+ 219,
+ "219",
+ "star-triangle-up-dot",
+ 319,
+ "319",
+ "star-triangle-up-open-dot",
+ 20,
+ "20",
+ "star-triangle-down",
+ 120,
+ "120",
+ "star-triangle-down-open",
+ 220,
+ "220",
+ "star-triangle-down-dot",
+ 320,
+ "320",
+ "star-triangle-down-open-dot",
+ 21,
+ "21",
+ "star-square",
+ 121,
+ "121",
+ "star-square-open",
+ 221,
+ "221",
+ "star-square-dot",
+ 321,
+ "321",
+ "star-square-open-dot",
+ 22,
+ "22",
+ "star-diamond",
+ 122,
+ "122",
+ "star-diamond-open",
+ 222,
+ "222",
+ "star-diamond-dot",
+ 322,
+ "322",
+ "star-diamond-open-dot",
+ 23,
+ "23",
+ "diamond-tall",
+ 123,
+ "123",
+ "diamond-tall-open",
+ 223,
+ "223",
+ "diamond-tall-dot",
+ 323,
+ "323",
+ "diamond-tall-open-dot",
+ 24,
+ "24",
+ "diamond-wide",
+ 124,
+ "124",
+ "diamond-wide-open",
+ 224,
+ "224",
+ "diamond-wide-dot",
+ 324,
+ "324",
+ "diamond-wide-open-dot",
+ 25,
+ "25",
+ "hourglass",
+ 125,
+ "125",
+ "hourglass-open",
+ 26,
+ "26",
+ "bowtie",
+ 126,
+ "126",
+ "bowtie-open",
+ 27,
+ "27",
+ "circle-cross",
+ 127,
+ "127",
+ "circle-cross-open",
+ 28,
+ "28",
+ "circle-x",
+ 128,
+ "128",
+ "circle-x-open",
+ 29,
+ "29",
+ "square-cross",
+ 129,
+ "129",
+ "square-cross-open",
+ 30,
+ "30",
+ "square-x",
+ 130,
+ "130",
+ "square-x-open",
+ 31,
+ "31",
+ "diamond-cross",
+ 131,
+ "131",
+ "diamond-cross-open",
+ 32,
+ "32",
+ "diamond-x",
+ 132,
+ "132",
+ "diamond-x-open",
+ 33,
+ "33",
+ "cross-thin",
+ 133,
+ "133",
+ "cross-thin-open",
+ 34,
+ "34",
+ "x-thin",
+ 134,
+ "134",
+ "x-thin-open",
+ 35,
+ "35",
+ "asterisk",
+ 135,
+ "135",
+ "asterisk-open",
+ 36,
+ "36",
+ "hash",
+ 136,
+ "136",
+ "hash-open",
+ 236,
+ "236",
+ "hash-dot",
+ 336,
+ "336",
+ "hash-open-dot",
+ 37,
+ "37",
+ "y-up",
+ 137,
+ "137",
+ "y-up-open",
+ 38,
+ "38",
+ "y-down",
+ 138,
+ "138",
+ "y-down-open",
+ 39,
+ "39",
+ "y-left",
+ 139,
+ "139",
+ "y-left-open",
+ 40,
+ "40",
+ "y-right",
+ 140,
+ "140",
+ "y-right-open",
+ 41,
+ "41",
+ "line-ew",
+ 141,
+ "141",
+ "line-ew-open",
+ 42,
+ "42",
+ "line-ns",
+ 142,
+ "142",
+ "line-ns-open",
+ 43,
+ "43",
+ "line-ne",
+ 143,
+ "143",
+ "line-ne-open",
+ 44,
+ "44",
+ "line-nw",
+ 144,
+ "144",
+ "line-nw-open",
+ 45,
+ "45",
+ "arrow-up",
+ 145,
+ "145",
+ "arrow-up-open",
+ 46,
+ "46",
+ "arrow-down",
+ 146,
+ "146",
+ "arrow-down-open",
+ 47,
+ "47",
+ "arrow-left",
+ 147,
+ "147",
+ "arrow-left-open",
+ 48,
+ "48",
+ "arrow-right",
+ 148,
+ "148",
+ "arrow-right-open",
+ 49,
+ "49",
+ "arrow-bar-up",
+ 149,
+ "149",
+ "arrow-bar-up-open",
+ 50,
+ "50",
+ "arrow-bar-down",
+ 150,
+ "150",
+ "arrow-bar-down-open",
+ 51,
+ "51",
+ "arrow-bar-left",
+ 151,
+ "151",
+ "arrow-bar-left-open",
+ 52,
+ "52",
+ "arrow-bar-right",
+ 152,
+ "152",
+ "arrow-bar-right-open",
+ 53,
+ "53",
+ "arrow",
+ 153,
+ "153",
+ "arrow-open",
+ 54,
+ "54",
+ "arrow-wide",
+ 154,
+ "154",
+ "arrow-wide-open"
+ ]
+ },
+ "symbolsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "mode": {
+ "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.",
+ "dflt": "markers",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "lines",
+ "markers",
+ "text"
+ ],
+ "valType": "flaglist"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "selected": {
+ "editType": "calc",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of selected points.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of selected points.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of selected points.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "text": {
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (lon,lat) pair or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the text font.",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "textposition": {
+ "arrayOk": true,
+ "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
+ "dflt": "middle center",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle left",
+ "middle center",
+ "middle right",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ]
+ },
+ "textpositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `lat`, `lon`, `location` and `text`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
+ "type": "scattergeo",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "unselected": {
+ "editType": "calc",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "opacity": {
+ "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ }
+ },
+ "categories": [
+ "geo",
+ "symbols",
+ "showLegend",
+ "scatter-like"
+ ],
+ "meta": {
+ "description": "The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in `lon` and `lat` respectively or by geographic location IDs or names in `locations`.",
+ "hrName": "scatter_geo"
+ },
+ "type": "scattergeo"
+ },
+ "scattergl": {
+ "animatable": false,
+ "attributes": {
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "dx": {
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "dy": {
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "error_x": {
+ "_deprecated": {
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "calc",
+ "valType": "number"
+ }
+ },
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "copy_ystyle": {
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "editType": "calc",
+ "role": "object",
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "traceref": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
+ ]
+ },
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "error_y": {
+ "_deprecated": {
+ "opacity": {
+ "description": "Obsolete. Use the alpha channel in error bar `color` to set the opacity.",
+ "editType": "calc",
+ "valType": "number"
+ }
+ },
+ "array": {
+ "description": "Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminus": {
+ "description": "Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "arrayminussrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `arrayminus`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "arraysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `array`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "color": {
+ "description": "Sets the stoke color of the error bars.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object",
+ "symmetric": {
+ "description": "Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "traceref": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "type": {
+ "description": "Determines the rule used to generate the error bars. If *constant`, the bar lengths are of a constant value. Set this constant in `value`. If *percent*, the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If *sqrt*, the bar lengths correspond to the square of the underlying data. If *data*, the bar lengths are set with data set `array`.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
+ ]
+ },
+ "value": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "valueminus": {
+ "description": "Sets the value of either the percentage (if `type` is set to *percent*) or the constant (if `type` is set to *constant*) corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "fill": {
+ "description": "Sets the area to fill with a solid color. Defaults to *none* unless this trace is stacked, then it gets *tonexty* (*tonextx*) if `orientation` is *v* (*h*) Use with `fillcolor` if not *none*. *tozerox* and *tozeroy* fill to x=0 and y=0 respectively. *tonextx* and *tonexty* fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like *tozerox* and *tozeroy*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. *tonext* fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like *toself* if there is no trace before it. *tonext* should not be used if one trace does not enclose the other. Traces in a `stackgroup` will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "tozeroy",
+ "tozerox",
+ "tonexty",
+ "tonextx",
+ "toself",
+ "tonext"
+ ]
+ },
+ "fillcolor": {
+ "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "dash": {
+ "description": "Sets the style of the lines.",
+ "dflt": "solid",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "dash",
+ "dashdot",
+ "dot",
+ "longdash",
+ "longdashdot",
+ "solid"
+ ]
+ },
+ "editType": "calc",
+ "role": "object",
+ "shape": {
+ "description": "Determines the line shape. The values correspond to step-wise line shapes.",
+ "dflt": "linear",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "linear",
+ "hv",
+ "vh",
+ "hvh",
+ "vhv"
+ ]
+ },
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "marker": {
+ "angle": {
+ "arrayOk": true,
+ "description": "Sets the marker angle in respect to `angleref`.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "angle"
+ },
+ "anglesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "calc",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "any"
+ },
+ {
+ "editType": "calc",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "calc",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
+ },
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "calc",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "line": {
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.line.colorscale`. Has an effect only if in `marker.line.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.line.color`) or the bounds set in `marker.line.cmin` and `marker.line.cmax` Has an effect only if in `marker.line.color` is set to a numerical array. Defaults to `false` when `marker.line.cmin` and `marker.line.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.line.cmin` and/or `marker.line.cmax` to be equidistant to this point. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color`. Has no effect when `marker.line.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.line.color` is set to a numerical array. Value should have the same units as in `marker.line.color` and if set, `marker.line.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.line.cmin` and `marker.line.cmax` if set.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.line.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.line.cmin` and `marker.line.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.line.color` is set to a numerical array. If true, `marker.line.cmin` will correspond to the last color in the array and `marker.line.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "widthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `width`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the marker opacity.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "opacitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the marker size (in px).",
+ "dflt": 6,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemin": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemode": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
+ "dflt": "diameter",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "diameter",
+ "area"
+ ]
+ },
+ "sizeref": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "symbol": {
+ "arrayOk": true,
+ "description": "Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name.",
+ "dflt": "circle",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ 0,
+ "0",
+ "circle",
+ 100,
+ "100",
+ "circle-open",
+ 200,
+ "200",
+ "circle-dot",
+ 300,
+ "300",
+ "circle-open-dot",
+ 1,
+ "1",
+ "square",
+ 101,
+ "101",
+ "square-open",
+ 201,
+ "201",
+ "square-dot",
+ 301,
+ "301",
+ "square-open-dot",
+ 2,
+ "2",
+ "diamond",
+ 102,
+ "102",
+ "diamond-open",
+ 202,
+ "202",
+ "diamond-dot",
+ 302,
+ "302",
+ "diamond-open-dot",
+ 3,
+ "3",
+ "cross",
+ 103,
+ "103",
+ "cross-open",
+ 203,
+ "203",
+ "cross-dot",
+ 303,
+ "303",
+ "cross-open-dot",
+ 4,
+ "4",
+ "x",
+ 104,
+ "104",
+ "x-open",
+ 204,
+ "204",
+ "x-dot",
+ 304,
+ "304",
+ "x-open-dot",
+ 5,
+ "5",
+ "triangle-up",
+ 105,
+ "105",
+ "triangle-up-open",
+ 205,
+ "205",
+ "triangle-up-dot",
+ 305,
+ "305",
+ "triangle-up-open-dot",
+ 6,
+ "6",
+ "triangle-down",
+ 106,
+ "106",
+ "triangle-down-open",
+ 206,
+ "206",
+ "triangle-down-dot",
+ 306,
+ "306",
+ "triangle-down-open-dot",
+ 7,
+ "7",
+ "triangle-left",
+ 107,
+ "107",
+ "triangle-left-open",
+ 207,
+ "207",
+ "triangle-left-dot",
+ 307,
+ "307",
+ "triangle-left-open-dot",
+ 8,
+ "8",
+ "triangle-right",
+ 108,
+ "108",
+ "triangle-right-open",
+ 208,
+ "208",
+ "triangle-right-dot",
+ 308,
+ "308",
+ "triangle-right-open-dot",
+ 9,
+ "9",
+ "triangle-ne",
+ 109,
+ "109",
+ "triangle-ne-open",
+ 209,
+ "209",
+ "triangle-ne-dot",
+ 309,
+ "309",
+ "triangle-ne-open-dot",
+ 10,
+ "10",
+ "triangle-se",
+ 110,
+ "110",
+ "triangle-se-open",
+ 210,
+ "210",
+ "triangle-se-dot",
+ 310,
+ "310",
+ "triangle-se-open-dot",
+ 11,
+ "11",
+ "triangle-sw",
+ 111,
+ "111",
+ "triangle-sw-open",
+ 211,
+ "211",
+ "triangle-sw-dot",
+ 311,
+ "311",
+ "triangle-sw-open-dot",
+ 12,
+ "12",
+ "triangle-nw",
+ 112,
+ "112",
+ "triangle-nw-open",
+ 212,
+ "212",
+ "triangle-nw-dot",
+ 312,
+ "312",
+ "triangle-nw-open-dot",
+ 13,
+ "13",
+ "pentagon",
+ 113,
+ "113",
+ "pentagon-open",
+ 213,
+ "213",
+ "pentagon-dot",
+ 313,
+ "313",
+ "pentagon-open-dot",
+ 14,
+ "14",
+ "hexagon",
+ 114,
+ "114",
+ "hexagon-open",
+ 214,
+ "214",
+ "hexagon-dot",
+ 314,
+ "314",
+ "hexagon-open-dot",
+ 15,
+ "15",
+ "hexagon2",
+ 115,
+ "115",
+ "hexagon2-open",
+ 215,
+ "215",
+ "hexagon2-dot",
+ 315,
+ "315",
+ "hexagon2-open-dot",
+ 16,
+ "16",
+ "octagon",
+ 116,
+ "116",
+ "octagon-open",
+ 216,
+ "216",
+ "octagon-dot",
+ 316,
+ "316",
+ "octagon-open-dot",
+ 17,
+ "17",
+ "star",
+ 117,
+ "117",
+ "star-open",
+ 217,
+ "217",
+ "star-dot",
+ 317,
+ "317",
+ "star-open-dot",
+ 18,
+ "18",
+ "hexagram",
+ 118,
+ "118",
+ "hexagram-open",
+ 218,
+ "218",
+ "hexagram-dot",
+ 318,
+ "318",
+ "hexagram-open-dot",
+ 19,
+ "19",
+ "star-triangle-up",
+ 119,
+ "119",
+ "star-triangle-up-open",
+ 219,
+ "219",
+ "star-triangle-up-dot",
+ 319,
+ "319",
+ "star-triangle-up-open-dot",
+ 20,
+ "20",
+ "star-triangle-down",
+ 120,
+ "120",
+ "star-triangle-down-open",
+ 220,
+ "220",
+ "star-triangle-down-dot",
+ 320,
+ "320",
+ "star-triangle-down-open-dot",
+ 21,
+ "21",
+ "star-square",
+ 121,
+ "121",
+ "star-square-open",
+ 221,
+ "221",
+ "star-square-dot",
+ 321,
+ "321",
+ "star-square-open-dot",
+ 22,
+ "22",
+ "star-diamond",
+ 122,
+ "122",
+ "star-diamond-open",
+ 222,
+ "222",
+ "star-diamond-dot",
+ 322,
+ "322",
+ "star-diamond-open-dot",
+ 23,
+ "23",
+ "diamond-tall",
+ 123,
+ "123",
+ "diamond-tall-open",
+ 223,
+ "223",
+ "diamond-tall-dot",
+ 323,
+ "323",
+ "diamond-tall-open-dot",
+ 24,
+ "24",
+ "diamond-wide",
+ 124,
+ "124",
+ "diamond-wide-open",
+ 224,
+ "224",
+ "diamond-wide-dot",
+ 324,
+ "324",
+ "diamond-wide-open-dot",
+ 25,
+ "25",
+ "hourglass",
+ 125,
+ "125",
+ "hourglass-open",
+ 26,
+ "26",
+ "bowtie",
+ 126,
+ "126",
+ "bowtie-open",
+ 27,
+ "27",
+ "circle-cross",
+ 127,
+ "127",
+ "circle-cross-open",
+ 28,
+ "28",
+ "circle-x",
+ 128,
+ "128",
+ "circle-x-open",
+ 29,
+ "29",
+ "square-cross",
+ 129,
+ "129",
+ "square-cross-open",
+ 30,
+ "30",
+ "square-x",
+ 130,
+ "130",
+ "square-x-open",
+ 31,
+ "31",
+ "diamond-cross",
+ 131,
+ "131",
+ "diamond-cross-open",
+ 32,
+ "32",
+ "diamond-x",
+ 132,
+ "132",
+ "diamond-x-open",
+ 33,
+ "33",
+ "cross-thin",
+ 133,
+ "133",
+ "cross-thin-open",
+ 34,
+ "34",
+ "x-thin",
+ 134,
+ "134",
+ "x-thin-open",
+ 35,
+ "35",
+ "asterisk",
+ 135,
+ "135",
+ "asterisk-open",
+ 36,
+ "36",
+ "hash",
+ 136,
+ "136",
+ "hash-open",
+ 236,
+ "236",
+ "hash-dot",
+ 336,
+ "336",
+ "hash-open-dot",
+ 37,
+ "37",
+ "y-up",
+ 137,
+ "137",
+ "y-up-open",
+ 38,
+ "38",
+ "y-down",
+ 138,
+ "138",
+ "y-down-open",
+ 39,
+ "39",
+ "y-left",
+ 139,
+ "139",
+ "y-left-open",
+ 40,
+ "40",
+ "y-right",
+ 140,
+ "140",
+ "y-right-open",
+ 41,
+ "41",
+ "line-ew",
+ 141,
+ "141",
+ "line-ew-open",
+ 42,
+ "42",
+ "line-ns",
+ 142,
+ "142",
+ "line-ns-open",
+ 43,
+ "43",
+ "line-ne",
+ 143,
+ "143",
+ "line-ne-open",
+ 44,
+ "44",
+ "line-nw",
+ 144,
+ "144",
+ "line-nw-open",
+ 45,
+ "45",
+ "arrow-up",
+ 145,
+ "145",
+ "arrow-up-open",
+ 46,
+ "46",
+ "arrow-down",
+ 146,
+ "146",
+ "arrow-down-open",
+ 47,
+ "47",
+ "arrow-left",
+ 147,
+ "147",
+ "arrow-left-open",
+ 48,
+ "48",
+ "arrow-right",
+ 148,
+ "148",
+ "arrow-right-open",
+ 49,
+ "49",
+ "arrow-bar-up",
+ 149,
+ "149",
+ "arrow-bar-up-open",
+ 50,
+ "50",
+ "arrow-bar-down",
+ 150,
+ "150",
+ "arrow-bar-down-open",
+ 51,
+ "51",
+ "arrow-bar-left",
+ 151,
+ "151",
+ "arrow-bar-left-open",
+ 52,
+ "52",
+ "arrow-bar-right",
+ 152,
+ "152",
+ "arrow-bar-right-open",
+ 53,
+ "53",
+ "arrow",
+ 153,
+ "153",
+ "arrow-open",
+ 54,
+ "54",
+ "arrow-wide",
+ 154,
+ "154",
+ "arrow-wide-open"
+ ]
+ },
+ "symbolsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "mode": {
+ "description": "Determines the drawing mode for this scatter trace.",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "lines",
+ "markers",
+ "text"
+ ],
+ "valType": "flaglist"
+ },
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "selected": {
+ "editType": "calc",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of selected points.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of selected points.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of selected points.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "selectedpoints": {
+ "description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean"
+ },
+ "stream": {
+ "editType": "calc",
+ "maxpoints": {
+ "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.",
+ "dflt": 500,
+ "editType": "calc",
+ "max": 10000,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "token": {
+ "description": "The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ }
+ },
+ "text": {
+ "arrayOk": true,
+ "description": "Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the text font.",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "bold"
+ ]
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "textposition": {
+ "arrayOk": true,
+ "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
+ "dflt": "middle center",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle left",
+ "middle center",
+ "middle right",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ]
+ },
+ "textpositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `text`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "texttemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "transforms": {
+ "items": {
+ "transform": {
+ "description": "WARNING: All transforms are deprecated and may be removed from the API in next major version. An array of operations that manipulate the trace data, for example filtering or sorting the data arrays.",
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "role": "object"
+ },
+ "type": "scattergl",
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string"
+ },
+ "uirevision": {
+ "description": "Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.",
+ "editType": "none",
+ "valType": "any"
+ },
+ "unselected": {
+ "editType": "calc",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "opacity": {
+ "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object"
+ }
+ },
+ "visible": {
+ "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ false,
+ "legendonly"
+ ]
+ },
+ "x": {
+ "description": "Sets the x coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "x0": {
+ "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "valType": "any"
+ },
+ "xaxis": {
+ "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
+ "dflt": "x",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "xperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "xperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "xperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
+ "dflt": "middle",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
+ },
+ "xsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `x`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "y": {
+ "description": "Sets the y coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array"
+ },
+ "y0": {
+ "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
+ "dflt": 0,
+ "editType": "calc+clearAxisTypes",
+ "valType": "any"
+ },
+ "yaxis": {
+ "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
+ "dflt": "y",
+ "editType": "calc+clearAxisTypes",
+ "valType": "subplotid"
+ },
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ]
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "yperiod": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
+ "dflt": 0,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "yperiod0": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
+ "editType": "calc",
+ "valType": "any"
+ },
+ "yperiodalignment": {
+ "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
+ "dflt": "middle",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "start",
+ "middle",
+ "end"
+ ]
+ },
+ "ysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `y`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "categories": [
+ "gl",
+ "regl",
+ "cartesian",
+ "symbols",
+ "errorBarsOK",
+ "showLegend",
+ "scatter-like"
+ ],
+ "meta": {
+ "description": "The data visualized as scatter point or lines is set in `x` and `y` using the WebGL plotting engine. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays.",
+ "hrName": "scatter_gl"
+ },
+ "type": "scattergl"
+ },
+ "scattermap": {
+ "animatable": false,
+ "attributes": {
+ "below": {
+ "description": "Determines if this scattermap trace's layers are to be inserted before the layer with the specified ID. By default, scattermap layers are inserted above all the base layers. To place the scattermap layers above every other layer, set `below` to *''*.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "cluster": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the color for each cluster step.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "enabled": {
+ "description": "Determines whether clustering is enabled or disabled.",
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "maxzoom": {
+ "description": "Sets the maximum zoom level. At zoom levels equal to or greater than this, points will never be clustered.",
+ "dflt": 24,
+ "editType": "calc",
+ "max": 24,
+ "min": 0,
+ "valType": "number"
+ },
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the marker opacity.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "opacitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the size for each cluster step.",
+ "dflt": 20,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "step": {
+ "arrayOk": true,
+ "description": "Sets how many points it takes to create a cluster or advance to the next cluster step. Use this in conjunction with arrays for `size` and / or `color`. If an integer, steps start at multiples of this number. If an array, each step extends from the given value until one less than the next value.",
+ "dflt": -1,
+ "editType": "calc",
+ "min": -1,
+ "valType": "number"
+ },
+ "stepsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `step`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "customdata": {
+ "description": "Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "customdatasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "fill": {
+ "description": "Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "toself"
+ ]
+ },
+ "fillcolor": {
+ "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.",
+ "dflt": "all",
+ "editType": "calc",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "lon",
+ "lat",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist"
+ },
+ "hoverinfosrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hoverlabel": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines",
+ "dflt": "auto",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "right",
+ "auto"
+ ]
+ },
+ "alignsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `align`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bgcolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color"
+ },
+ "bordercolorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "description": "Sets the font used in hover labels.",
+ "editType": "none",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "familysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `family`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lineposition": {
+ "arrayOk": true,
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "none",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "linepositionsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object",
+ "shadow": {
+ "arrayOk": true,
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "none",
+ "valType": "string"
+ },
+ "shadowsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "stylesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `style`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "textcase": {
+ "arrayOk": true,
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "textcasesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "variantsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ },
+ "weightsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "namelength": {
+ "arrayOk": true,
+ "description": "Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.",
+ "dflt": 15,
+ "editType": "none",
+ "min": -1,
+ "valType": "integer"
+ },
+ "namelengthsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "role": "object"
+ },
+ "hovertemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `` is displayed in the secondary box, for example \"{fullData.name}\". To hide the secondary box completely, use an empty tag ``.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertemplatesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Sets hover text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "hovertextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "ids": {
+ "description": "Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "idssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "lat": {
+ "description": "Sets the latitude coordinates (in degrees North).",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "latsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "legend": {
+ "description": "Sets the reference to a legend to show this trace in. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
+ "dflt": "legend",
+ "editType": "style",
+ "valType": "subplotid"
+ },
+ "legendgroup": {
+ "description": "Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color"
+ },
+ "description": "Sets this legend group's title font.",
+ "editType": "style",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "style",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "style",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string"
+ }
+ },
+ "legendrank": {
+ "description": "Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with *reversed* `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.",
+ "dflt": 1000,
+ "editType": "style",
+ "valType": "number"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ }
+ },
+ "lon": {
+ "description": "Sets the longitude coordinates (in degrees East).",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "lonsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "marker": {
+ "allowoverlap": {
+ "description": "Flag to draw all symbols, even if they overlap.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "angle": {
+ "arrayOk": true,
+ "description": "Sets the marker orientation from true North, in degrees clockwise. When using the *auto* default, no rotation would be applied in perspective views which is different from using a zero angle.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "anglesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "autocolorscale": {
+ "description": "Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.color` is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cauto": {
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here in `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color` is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.",
+ "dflt": true,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "boolean"
+ },
+ "cmax": {
+ "description": "Sets the upper bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "cmid": {
+ "description": "Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "number"
+ },
+ "cmin": {
+ "description": "Sets the lower bound of the color domain. Has an effect only if in `marker.color` is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "cauto": false
+ },
+ "valType": "number"
+ },
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "coloraxis": {
+ "description": "Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.",
+ "dflt": null,
+ "editType": "calc",
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid"
+ },
+ "colorbar": {
+ "_deprecated": {
+ "title": {
+ "description": "Deprecated in favor of color bar's `title.text`. Note that value of color bar's `title` is no longer a simple *string* but a set of sub-attributes.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "titlefont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Deprecated in favor of color bar's `title.font`.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "titleside": {
+ "description": "Deprecated in favor of color bar's `title.side`.",
+ "dflt": "top",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ }
+ },
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "dtick": {
+ "description": "Sets the step in-between ticks on this axis. Use with `tick0`. Must be a positive number, or special strings available to *log* and *date* axes. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. *log* has several special values; *L*, where `f` is a positive number, gives ticks linearly spaced in value (but not position). For example `tick0` = 0.1, `dtick` = *L0.5* will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use *D1* (all digits) or *D2* (only 2 and 5). `tick0` is ignored for *D1* and *D2*. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0. *date* also has special values *M* gives ticks spaced by a number of months. `n` must be a positive integer. To set ticks on the 15th of every third month, set `tick0` to *2000-01-15* and `dtick` to *M3*. To set ticks every 4 years, set `dtick` to *M48*",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "editType": "calc",
+ "exponentformat": {
+ "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B"
+ ]
+ },
+ "labelalias": {
+ "description": "Replacement text for specific tick or hover labels. For example using {US: 'USA', CA: 'Canada'} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "any"
+ },
+ "len": {
+ "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "lenmode": {
+ "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.",
+ "dflt": "fraction",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "minexponent": {
+ "description": "Hide SI prefix for 10^n if |n| is below this number. This only has an effect when `tickformat` is *SI* or *B*.",
+ "dflt": 3,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "nticks": {
+ "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ]
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showexponent": {
+ "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "showtickprefix": {
+ "description": "If *all*, all tick labels are displayed with a prefix. If *first*, only the first tick is displayed with a prefix. If *last*, only the last tick is displayed with a suffix. If *none*, tick prefixes are hidden.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ]
+ },
+ "thickness": {
+ "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
+ "dflt": 30,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "thicknessmode": {
+ "description": "Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot *fraction* or in *pixels*. Use `thickness` to set the value.",
+ "dflt": "pixels",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ]
+ },
+ "tick0": {
+ "description": "Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is *log*, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2) except when `dtick`=*L* (see `dtick` for more info). If the axis `type` is *date*, it should be a date string, like date data. If the axis `type` is *category*, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.",
+ "editType": "calc",
+ "impliedEdits": {
+ "tickmode": "linear"
+ },
+ "valType": "any"
+ },
+ "tickangle": {
+ "description": "Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "angle"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets the color bar's tick label font",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "tickformat": {
+ "description": "Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "tickformatstops": {
+ "items": {
+ "tickformatstop": {
+ "dtickrange": {
+ "description": "range [*min*, *max*], where *min*, *max* - dtick values which describe some zoom level, it is possible to omit *min* or *max* value by passing *null*",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "any"
+ },
+ {
+ "editType": "calc",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array"
+ },
+ "editType": "calc",
+ "enabled": {
+ "description": "Determines whether or not this stop is used. If `false`, this stop is ignored even within its `dtickrange`.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "name": {
+ "description": "When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "role": "object",
+ "templateitemname": {
+ "description": "Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "value": {
+ "description": "string - dtickformat for described zoom level, the same as *tickformat*",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ }
+ }
+ },
+ "role": "object"
+ },
+ "ticklabeloverflow": {
+ "description": "Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is *hide past domain*. In other cases the default is *hide past div*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ]
+ },
+ "ticklabelposition": {
+ "description": "Determines where tick labels are drawn relative to the ticks. Left and right options are used when `orientation` is *h*, top and bottom when `orientation` is *v*.",
+ "dflt": "outside",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
+ ]
+ },
+ "ticklabelstep": {
+ "description": "Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. `tick0` determines which labels are shown. Not implemented for axes with `type` *log* or *multicategory*, or when `tickmode` is *array*.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 1,
+ "valType": "integer"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "tickmode": {
+ "description": "Sets the tick mode for this axis. If *auto*, the number of ticks is set via `nticks`. If *linear*, the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` (*linear* is the default value if `tick0` and `dtick` are provided). If *array*, the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. (*array* is the default value if `tickvals` is provided).",
+ "editType": "calc",
+ "impliedEdits": {},
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ]
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticks": {
+ "description": "Determines whether ticks are drawn or not. If **, this axis' ticks are not drawn. If *outside* (*inside*), this axis' are drawn outside (inside) the axis lines.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "outside",
+ "inside",
+ ""
+ ]
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "ticktext": {
+ "description": "Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to *array*. Used with `tickvals`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "ticktextsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickvals": {
+ "description": "Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to *array*. Used with `ticktext`.",
+ "editType": "calc",
+ "valType": "data_array"
+ },
+ "tickvalssrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color"
+ },
+ "description": "Sets this color bar's title font. Note that the title's font used to be set by the now deprecated `titlefont` attribute.",
+ "editType": "calc",
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string"
+ },
+ "lineposition": {
+ "description": "Sets the kind of decoration line(s) with text, such as an *under*, *over* or *through* as well as combinations e.g. *under+over*, etc.",
+ "dflt": "none",
+ "editType": "calc",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist"
+ },
+ "role": "object",
+ "shadow": {
+ "description": "Sets the shape and color of the shadow behind text. *auto* places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.",
+ "dflt": "none",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number"
+ },
+ "style": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ]
+ },
+ "textcase": {
+ "description": "Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ]
+ },
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ]
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
+ }
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` if *v* and defaults to *right* when `orientation` if *h*. Note that the title's location used to be set by the now deprecated `titleside` attribute.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ]
+ },
+ "text": {
+ "description": "Sets the title of the color bar. Note that before the existence of `title.text`, the title's contents used to be defined as the `title` attribute itself. This behavior has been deprecated.",
+ "editType": "calc",
+ "valType": "string"
+ }
+ },
+ "x": {
+ "description": "Sets the x position with respect to `xref` of the color bar (in plot fraction). When `xref` is *paper*, defaults to 1.02 when `orientation` is *v* and 0.5 when `orientation` is *h*. When `xref` is *container*, defaults to *1* when `orientation` is *v* and 0.5 when `orientation` is *h*. Must be between *0* and *1* if `xref` is *container* and between *-2* and *3* if `xref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "xanchor": {
+ "description": "Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the color bar. Defaults to *left* when `orientation` is *v* and *center* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ]
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "xref": {
+ "description": "Sets the container `x` refers to. *container* spans the entire `width` of the plot. *paper* refers to the width of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ },
+ "y": {
+ "description": "Sets the y position with respect to `yref` of the color bar (in plot fraction). When `yref` is *paper*, defaults to 0.5 when `orientation` is *v* and 1.02 when `orientation` is *h*. When `yref` is *container*, defaults to 0.5 when `orientation` is *v* and 1 when `orientation` is *h*. Must be between *0* and *1* if `yref` is *container* and between *-2* and *3* if `yref` is *paper*.",
+ "editType": "calc",
+ "valType": "number"
+ },
+ "yanchor": {
+ "description": "Sets this color bar's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the color bar. Defaults to *middle* when `orientation` is *v* and *bottom* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ]
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "yref": {
+ "description": "Sets the container `y` refers to. *container* spans the entire `height` of the plot. *paper* refers to the height of the plotting area only.",
+ "dflt": "paper",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ]
+ }
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. Has an effect only if in `marker.color` is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.",
+ "dflt": null,
+ "editType": "calc",
+ "impliedEdits": {
+ "autocolorscale": false
+ },
+ "valType": "colorscale"
+ },
+ "colorsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "editType": "calc",
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the marker opacity.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "opacitysrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "reversescale": {
+ "description": "Reverses the color mapping if true. Has an effect only if in `marker.color` is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "role": "object",
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color` is set to a numerical array.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean"
+ },
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the marker size (in px).",
+ "dflt": 6,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemin": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number"
+ },
+ "sizemode": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.",
+ "dflt": "diameter",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "diameter",
+ "area"
+ ]
+ },
+ "sizeref": {
+ "description": "Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number"
+ },
+ "sizesrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "symbol": {
+ "arrayOk": true,
+ "description": "Sets the marker symbol. Full list: https://www.map.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for *circle* symbols.",
+ "dflt": "circle",
+ "editType": "calc",
+ "valType": "string"
+ },
+ "symbolsrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
+ "editType": "none",
+ "valType": "string"
+ }
+ },
+ "meta": {
+ "arrayOk": true,
+ "description": "Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.",
+ "editType": "plot",
+ "valType": "any"
+ },
+ "metasrc": {
+ "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
+ "editType": "none",
+ "valType": "string"
+ },
+ "mode": {
+ "description": "Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover.",
+ "dflt": "markers",
"editType": "calc",
"extras": [
"none"
@@ -73720,7 +78707,7 @@
"opacity": {
"description": "Sets the opacity of the trace.",
"dflt": 1,
- "editType": "calc",
+ "editType": "style",
"max": 1,
"min": 0,
"valType": "number"
@@ -73749,16 +78736,7 @@
"valType": "number"
}
},
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of selected points.",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object"
- }
+ "role": "object"
},
"selectedpoints": {
"description": "Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.",
@@ -73790,53 +78768,41 @@
"valType": "string"
}
},
+ "subplot": {
+ "description": "Sets a reference between this trace's data coordinates and a map subplot. If *map* (the default value), the data refer to `layout.map`. If *map2*, the data refer to `layout.map2`, and so on.",
+ "dflt": "map",
+ "editType": "calc",
+ "valType": "subplotid"
+ },
"text": {
"arrayOk": true,
- "description": "Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "description": "Sets text elements associated with each (lon,lat) pair If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"dflt": "",
"editType": "calc",
"valType": "string"
},
"textfont": {
"color": {
- "arrayOk": true,
"editType": "calc",
"valType": "color"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "description": "Sets the text font.",
+ "description": "Sets the icon text font (color=map.layer.paint.text-color, size=map.layer.layout.text-size). Has an effect only when `type` is set to *symbol*.",
"editType": "calc",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.",
+ "dflt": "Open Sans Regular, Arial Unicode MS Regular",
"editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"size": {
- "arrayOk": true,
"editType": "calc",
"min": 1,
"valType": "number"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"style": {
- "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
"editType": "calc",
@@ -73846,46 +78812,21 @@
"italic"
]
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
- },
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "normal",
- "small-caps"
- ]
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
- },
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
"editType": "calc",
- "valType": "enumerated",
- "values": [
+ "extras": [
"normal",
"bold"
- ]
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer"
}
},
"textposition": {
- "arrayOk": true,
+ "arrayOk": false,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
"dflt": "middle center",
"editType": "calc",
@@ -73902,11 +78843,6 @@
"bottom right"
]
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"textsrc": {
"description": "Sets the source reference on Chart Studio Cloud for `text`.",
"editType": "none",
@@ -73914,7 +78850,7 @@
},
"texttemplate": {
"arrayOk": true,
- "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
+ "description": "Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `lat`, `lon` and `text`.",
"dflt": "",
"editType": "calc",
"valType": "string"
@@ -73934,7 +78870,7 @@
},
"role": "object"
},
- "type": "scattergl",
+ "type": "scattermap",
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
@@ -73969,16 +78905,7 @@
"valType": "number"
}
},
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of unselected points, applied only when a selection exists.",
- "editType": "calc",
- "valType": "color"
- },
- "editType": "calc",
- "role": "object"
- }
+ "role": "object"
},
"visible": {
"description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).",
@@ -73990,170 +78917,20 @@
false,
"legendonly"
]
- },
- "x": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "x0": {
- "description": "Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any"
- },
- "xaxis": {
- "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.",
- "dflt": "x",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "xhoverformat": {
- "description": "Sets the hover text formatting rulefor `x` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `xaxis.hoverformat`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "xperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "valType": "any"
- },
- "xperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the x0 axis. When `x0period` is round number of weeks, the `x0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "xperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
- "dflt": "middle",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "y": {
- "description": "Sets the y coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array"
- },
- "y0": {
- "description": "Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.",
- "dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any"
- },
- "yaxis": {
- "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.yaxis2`, and so on.",
- "dflt": "y",
- "editType": "calc+clearAxisTypes",
- "valType": "subplotid"
- },
- "ycalendar": {
- "description": "Sets the calendar system to use with `y` date data.",
- "dflt": "gregorian",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ]
- },
- "yhoverformat": {
- "description": "Sets the hover text formatting rulefor `y` using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*By default the values are formatted using `yaxis.hoverformat`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string"
- },
- "yperiod": {
- "description": "Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the y axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.",
- "dflt": 0,
- "editType": "calc",
- "valType": "any"
- },
- "yperiod0": {
- "description": "Only relevant when the axis `type` is *date*. Sets the base for period positioning in milliseconds or date string on the y0 axis. When `y0period` is round number of weeks, the `y0period0` by default would be on a Sunday i.e. 2000-01-02, otherwise it would be at 2000-01-01.",
- "editType": "calc",
- "valType": "any"
- },
- "yperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
- "dflt": "middle",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ]
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
}
},
"categories": [
+ "map",
"gl",
- "regl",
- "cartesian",
"symbols",
- "errorBarsOK",
"showLegend",
"scatter-like"
],
"meta": {
- "description": "The data visualized as scatter point or lines is set in `x` and `y` using the WebGL plotting engine. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays.",
- "hrName": "scatter_gl"
+ "description": "The data visualized as scatter point, lines or marker symbols on a MapLibre GL geographic map is provided by longitude/latitude pairs in `lon` and `lat`.",
+ "hrName": "scatter_map"
},
- "type": "scattergl"
+ "type": "scattermap"
},
"scattermapbox": {
"animatable": false,
@@ -75645,7 +80422,7 @@
}
},
"subplot": {
- "description": "Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.",
+ "description": "mapbox subplots and traces are deprecated! Please consider switching to `map` subplots and traces. Learn more at: https://plotly.com/javascript/maplibre-migration/ Sets a reference between this trace's data coordinates and a mapbox subplot. If *mapbox* (the default value), the data refer to `layout.mapbox`. If *mapbox2*, the data refer to `layout.mapbox2`, and so on.",
"dflt": "mapbox",
"editType": "calc",
"valType": "subplotid"
@@ -75803,7 +80580,7 @@
"scatter-like"
],
"meta": {
- "description": "The data visualized as scatter point, lines or marker symbols on a Mapbox GL geographic map is provided by longitude/latitude pairs in `lon` and `lat`.",
+ "description": "*scattermapbox* trace is deprecated! Please consider switching to the *scattermap* trace type and `map` subplots. Learn more at: https://plotly.com/javascript/maplibre-migration/ The data visualized as scatter point, lines or marker symbols on a Mapbox GL geographic map is provided by longitude/latitude pairs in `lon` and `lat`.",
"hrName": "scatter_mapbox"
},
"type": "scattermapbox"
diff --git a/packages/python/plotly/plotly/_subplots.py b/packages/python/plotly/plotly/_subplots.py
index 51898363975..a1bb4219c94 100644
--- a/packages/python/plotly/plotly/_subplots.py
+++ b/packages/python/plotly/plotly/_subplots.py
@@ -8,7 +8,7 @@
# little differently.
import collections
-_single_subplot_types = {"scene", "geo", "polar", "ternary", "mapbox"}
+_single_subplot_types = {"scene", "geo", "polar", "ternary", "map", "mapbox"}
_subplot_types = set.union(_single_subplot_types, {"xy", "domain"})
# For most subplot types, a trace is associated with a particular subplot
@@ -20,7 +20,7 @@
# the trace property is just named `subplot`. For example setting
# the `scatterpolar.subplot` property to `polar3` associates the scatterpolar
# trace with the third polar subplot in the figure
-_subplot_prop_named_subplot = {"polar", "ternary", "mapbox"}
+_subplot_prop_named_subplot = {"polar", "ternary", "map", "mapbox"}
# Named tuple to hold an xaxis/yaxis pair that represent a single subplot
@@ -150,7 +150,8 @@ def make_subplots(
- 'scene': 3D Cartesian subplot for scatter3d, cone, etc.
- 'polar': Polar subplot for scatterpolar, barpolar, etc.
- 'ternary': Ternary subplot for scatterternary
- - 'mapbox': Mapbox subplot for scattermapbox
+ - 'map': Map subplot for scattermap, choroplethmap and densitymap
+ - 'mapbox': Mapbox subplot for scattermapbox, choroplethmapbox and densitymapbox
- 'domain': Subplot type for traces that are individually
positioned. pie, parcoords, parcats, etc.
- trace type: A trace type which will be used to determine
diff --git a/packages/python/plotly/plotly/_widget_version.py b/packages/python/plotly/plotly/_widget_version.py
index 43a73f59541..ead97dfc2d4 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__ = "^5.23.0"
+__frontend_version__ = "^5.24.0"
diff --git a/packages/python/plotly/plotly/express/__init__.py b/packages/python/plotly/plotly/express/__init__.py
index 4dd37f64fc3..935d6745788 100644
--- a/packages/python/plotly/plotly/express/__init__.py
+++ b/packages/python/plotly/plotly/express/__init__.py
@@ -17,12 +17,14 @@
scatter_3d,
scatter_polar,
scatter_ternary,
+ scatter_map,
scatter_mapbox,
scatter_geo,
line,
line_3d,
line_polar,
line_ternary,
+ line_map,
line_mapbox,
line_geo,
area,
@@ -46,7 +48,9 @@
icicle,
funnel,
funnel_area,
+ choropleth_map,
choropleth_mapbox,
+ density_map,
density_mapbox,
)
@@ -67,16 +71,19 @@
"scatter_3d",
"scatter_polar",
"scatter_ternary",
+ "scatter_map",
"scatter_mapbox",
"scatter_geo",
"scatter_matrix",
"density_contour",
"density_heatmap",
+ "density_map",
"density_mapbox",
"line",
"line_3d",
"line_polar",
"line_ternary",
+ "line_map",
"line_mapbox",
"line_geo",
"parallel_coordinates",
@@ -91,6 +98,7 @@
"histogram",
"ecdf",
"choropleth",
+ "choropleth_map",
"choropleth_mapbox",
"pie",
"sunburst",
diff --git a/packages/python/plotly/plotly/express/_chart_types.py b/packages/python/plotly/plotly/express/_chart_types.py
index 74cdf84fa49..b444c0f25d7 100644
--- a/packages/python/plotly/plotly/express/_chart_types.py
+++ b/packages/python/plotly/plotly/express/_chart_types.py
@@ -1211,6 +1211,153 @@ def line_geo(
line_geo.__doc__ = make_docstring(line_geo)
+def scatter_map(
+ data_frame=None,
+ lat=None,
+ lon=None,
+ color=None,
+ text=None,
+ hover_name=None,
+ hover_data=None,
+ custom_data=None,
+ size=None,
+ animation_frame=None,
+ animation_group=None,
+ category_orders=None,
+ labels=None,
+ color_discrete_sequence=None,
+ color_discrete_map=None,
+ color_continuous_scale=None,
+ range_color=None,
+ color_continuous_midpoint=None,
+ opacity=None,
+ size_max=None,
+ zoom=8,
+ center=None,
+ map_style=None,
+ title=None,
+ template=None,
+ width=None,
+ height=None,
+) -> go.Figure:
+ """
+ In a scatter map, each row of `data_frame` is represented by a
+ symbol mark on the map.
+ """
+ return make_figure(args=locals(), constructor=go.Scattermap)
+
+
+scatter_map.__doc__ = make_docstring(scatter_map)
+
+
+def choropleth_map(
+ data_frame=None,
+ geojson=None,
+ featureidkey=None,
+ locations=None,
+ color=None,
+ hover_name=None,
+ hover_data=None,
+ custom_data=None,
+ animation_frame=None,
+ animation_group=None,
+ category_orders=None,
+ labels=None,
+ color_discrete_sequence=None,
+ color_discrete_map=None,
+ color_continuous_scale=None,
+ range_color=None,
+ color_continuous_midpoint=None,
+ opacity=None,
+ zoom=8,
+ center=None,
+ map_style=None,
+ title=None,
+ template=None,
+ width=None,
+ height=None,
+) -> go.Figure:
+ """
+ In a choropleth map, each row of `data_frame` is represented by a
+ colored region on the map.
+ """
+ return make_figure(args=locals(), constructor=go.Choroplethmap)
+
+
+choropleth_map.__doc__ = make_docstring(choropleth_map)
+
+
+def density_map(
+ data_frame=None,
+ lat=None,
+ lon=None,
+ z=None,
+ hover_name=None,
+ hover_data=None,
+ custom_data=None,
+ animation_frame=None,
+ animation_group=None,
+ category_orders=None,
+ labels=None,
+ color_continuous_scale=None,
+ range_color=None,
+ color_continuous_midpoint=None,
+ opacity=None,
+ zoom=8,
+ center=None,
+ map_style=None,
+ radius=None,
+ title=None,
+ template=None,
+ width=None,
+ height=None,
+) -> go.Figure:
+ """
+ In a density map, each row of `data_frame` contributes to the intensity of
+ the color of the region around the corresponding point on the map
+ """
+ return make_figure(
+ args=locals(), constructor=go.Densitymap, trace_patch=dict(radius=radius)
+ )
+
+
+density_map.__doc__ = make_docstring(density_map)
+
+
+def line_map(
+ data_frame=None,
+ lat=None,
+ lon=None,
+ color=None,
+ text=None,
+ hover_name=None,
+ hover_data=None,
+ custom_data=None,
+ line_group=None,
+ animation_frame=None,
+ animation_group=None,
+ category_orders=None,
+ labels=None,
+ color_discrete_sequence=None,
+ color_discrete_map=None,
+ zoom=8,
+ center=None,
+ map_style=None,
+ title=None,
+ template=None,
+ width=None,
+ height=None,
+) -> go.Figure:
+ """
+ In a line map, each row of `data_frame` is represented as
+ vertex of a polyline mark on the map.
+ """
+ return make_figure(args=locals(), constructor=go.Scattermap)
+
+
+line_map.__doc__ = make_docstring(line_map)
+
+
def scatter_mapbox(
data_frame=None,
lat=None,
diff --git a/packages/python/plotly/plotly/express/_core.py b/packages/python/plotly/plotly/express/_core.py
index 36c57055331..9a79810506d 100644
--- a/packages/python/plotly/plotly/express/_core.py
+++ b/packages/python/plotly/plotly/express/_core.py
@@ -426,7 +426,11 @@ def make_trace_kwargs(args, trace_spec, trace_data, mapping_labels, sizeref):
# as a list of row lists, which is what we want
trace_patch["customdata"] = trace_data[customdata_cols]
elif attr_name == "color":
- if trace_spec.constructor in [go.Choropleth, go.Choroplethmapbox]:
+ if trace_spec.constructor in [
+ go.Choropleth,
+ go.Choroplethmap,
+ go.Choroplethmapbox,
+ ]:
trace_patch["z"] = trace_data[attr_value]
trace_patch["coloraxis"] = "coloraxis1"
mapping_labels[attr_label] = "%{z}"
@@ -532,6 +536,9 @@ def configure_axes(args, constructor, fig, orders):
go.Scatterpolar: configure_polar_axes,
go.Scatterpolargl: configure_polar_axes,
go.Barpolar: configure_polar_axes,
+ go.Scattermap: configure_map,
+ go.Choroplethmap: configure_map,
+ go.Densitymap: configure_map,
go.Scattermapbox: configure_mapbox,
go.Choroplethmapbox: configure_mapbox,
go.Densitymapbox: configure_mapbox,
@@ -739,6 +746,20 @@ def configure_mapbox(args, fig, orders):
)
+def configure_map(args, fig, orders):
+ center = args["center"]
+ if not center and "lat" in args and "lon" in args:
+ center = dict(
+ lat=args["data_frame"][args["lat"]].mean(),
+ lon=args["data_frame"][args["lon"]].mean(),
+ )
+ fig.update_maps(
+ center=center,
+ zoom=args["zoom"],
+ style=args["map_style"],
+ )
+
+
def configure_geo(args, fig, orders):
fig.update_geos(
center=args["center"],
@@ -1911,7 +1932,7 @@ def infer_config(args, constructor, trace_patch, layout_patch):
else:
trace_patch["texttemplate"] = "%{" + letter + ":" + args["text_auto"] + "}"
- if constructor in [go.Histogram2d, go.Densitymapbox]:
+ if constructor in [go.Histogram2d, go.Densitymap, go.Densitymapbox]:
show_colorbar = True
trace_patch["coloraxis"] = "coloraxis1"
@@ -1919,7 +1940,13 @@ def infer_config(args, constructor, trace_patch, layout_patch):
if args["opacity"] is None:
if "barmode" in args and args["barmode"] == "overlay":
trace_patch["marker"] = dict(opacity=0.5)
- elif constructor in [go.Densitymapbox, go.Pie, go.Funnel, go.Funnelarea]:
+ elif constructor in [
+ go.Densitymap,
+ go.Densitymapbox,
+ go.Pie,
+ go.Funnel,
+ go.Funnelarea,
+ ]:
trace_patch["opacity"] = args["opacity"]
else:
trace_patch["marker"] = dict(opacity=args["opacity"])
@@ -1937,7 +1964,7 @@ def infer_config(args, constructor, trace_patch, layout_patch):
modes.add("lines")
trace_patch["mode"] = "+".join(sorted(modes))
elif constructor != go.Splom and (
- "symbol" in args or constructor == go.Scattermapbox
+ "symbol" in args or constructor in [go.Scattermap, go.Scattermapbox]
):
trace_patch["mode"] = "markers" + ("+text" if args["text"] else "")
@@ -2154,7 +2181,9 @@ def make_figure(args, constructor, trace_patch=None, layout_patch=None):
go.Parcats,
go.Parcoords,
go.Choropleth,
+ go.Choroplethmap,
go.Choroplethmapbox,
+ go.Densitymap,
go.Densitymapbox,
go.Histogram2d,
go.Sunburst,
@@ -2198,7 +2227,8 @@ def make_figure(args, constructor, trace_patch=None, layout_patch=None):
):
trace.update(marker=dict(color=m.val_map[val]))
elif (
- trace_spec.constructor in [go.Choropleth, go.Choroplethmapbox]
+ trace_spec.constructor
+ in [go.Choropleth, go.Choroplethmap, go.Choroplethmapbox]
and m.variable == "color"
):
trace.update(
@@ -2281,7 +2311,11 @@ def make_figure(args, constructor, trace_patch=None, layout_patch=None):
)
if show_colorbar:
- colorvar = "z" if constructor in [go.Histogram2d, go.Densitymapbox] else "color"
+ colorvar = (
+ "z"
+ if constructor in [go.Histogram2d, go.Densitymap, go.Densitymapbox]
+ else "color"
+ )
range_color = args["range_color"] or [None, None]
colorscale_validator = ColorscaleValidator("colorscale", "make_figure")
diff --git a/packages/python/plotly/plotly/express/_doc.py b/packages/python/plotly/plotly/express/_doc.py
index ebab116b42e..75f09b6fab1 100644
--- a/packages/python/plotly/plotly/express/_doc.py
+++ b/packages/python/plotly/plotly/express/_doc.py
@@ -531,6 +531,11 @@
"Dict keys are `'lat'` and `'lon'`",
"Sets the center point of the map.",
],
+ map_style=[
+ "str (default `'basic'`)",
+ "Identifier of base map style.",
+ "Allowed values are `'basic'`, `'carto-darkmatter'`, `'carto-darkmatter-nolabels'`, `'carto-positron'`, `'carto-positron-nolabels'`, `'carto-voyager'`, `'carto-voyager-nolabels'`, `'dark'`, `'light'`, `'open-street-map'`, `'outdoors'`, `'satellite'`, `'satellite-streets'`, `'streets'`, `'white-bg'`.",
+ ],
mapbox_style=[
"str (default `'basic'`, needs Mapbox API token)",
"Identifier of base map style, some of which require a Mapbox or Stadia Maps API token to be set using `plotly.express.set_mapbox_access_token()`.",
diff --git a/packages/python/plotly/plotly/graph_objects/__init__.py b/packages/python/plotly/plotly/graph_objects/__init__.py
index d69329669a4..a2215ba362f 100644
--- a/packages/python/plotly/plotly/graph_objects/__init__.py
+++ b/packages/python/plotly/plotly/graph_objects/__init__.py
@@ -16,6 +16,7 @@
from ..graph_objs import Scatterpolargl
from ..graph_objs import Scatterpolar
from ..graph_objs import Scattermapbox
+ from ..graph_objs import Scattermap
from ..graph_objs import Scattergl
from ..graph_objs import Scattergeo
from ..graph_objs import Scattercarpet
@@ -40,10 +41,12 @@
from ..graph_objs import Funnelarea
from ..graph_objs import Funnel
from ..graph_objs import Densitymapbox
+ from ..graph_objs import Densitymap
from ..graph_objs import Contourcarpet
from ..graph_objs import Contour
from ..graph_objs import Cone
from ..graph_objs import Choroplethmapbox
+ from ..graph_objs import Choroplethmap
from ..graph_objs import Choropleth
from ..graph_objs import Carpet
from ..graph_objs import Candlestick
@@ -92,6 +95,7 @@
from ..graph_objs import scatterpolargl
from ..graph_objs import scatterpolar
from ..graph_objs import scattermapbox
+ from ..graph_objs import scattermap
from ..graph_objs import scattergl
from ..graph_objs import scattergeo
from ..graph_objs import scattercarpet
@@ -116,10 +120,12 @@
from ..graph_objs import funnelarea
from ..graph_objs import funnel
from ..graph_objs import densitymapbox
+ from ..graph_objs import densitymap
from ..graph_objs import contourcarpet
from ..graph_objs import contour
from ..graph_objs import cone
from ..graph_objs import choroplethmapbox
+ from ..graph_objs import choroplethmap
from ..graph_objs import choropleth
from ..graph_objs import carpet
from ..graph_objs import candlestick
@@ -147,6 +153,7 @@
"..graph_objs.scatterpolargl",
"..graph_objs.scatterpolar",
"..graph_objs.scattermapbox",
+ "..graph_objs.scattermap",
"..graph_objs.scattergl",
"..graph_objs.scattergeo",
"..graph_objs.scattercarpet",
@@ -171,10 +178,12 @@
"..graph_objs.funnelarea",
"..graph_objs.funnel",
"..graph_objs.densitymapbox",
+ "..graph_objs.densitymap",
"..graph_objs.contourcarpet",
"..graph_objs.contour",
"..graph_objs.cone",
"..graph_objs.choroplethmapbox",
+ "..graph_objs.choroplethmap",
"..graph_objs.choropleth",
"..graph_objs.carpet",
"..graph_objs.candlestick",
@@ -198,6 +207,7 @@
"..graph_objs.Scatterpolargl",
"..graph_objs.Scatterpolar",
"..graph_objs.Scattermapbox",
+ "..graph_objs.Scattermap",
"..graph_objs.Scattergl",
"..graph_objs.Scattergeo",
"..graph_objs.Scattercarpet",
@@ -222,10 +232,12 @@
"..graph_objs.Funnelarea",
"..graph_objs.Funnel",
"..graph_objs.Densitymapbox",
+ "..graph_objs.Densitymap",
"..graph_objs.Contourcarpet",
"..graph_objs.Contour",
"..graph_objs.Cone",
"..graph_objs.Choroplethmapbox",
+ "..graph_objs.Choroplethmap",
"..graph_objs.Choropleth",
"..graph_objs.Carpet",
"..graph_objs.Candlestick",
diff --git a/packages/python/plotly/plotly/graph_objs/__init__.py b/packages/python/plotly/plotly/graph_objs/__init__.py
index d10f2e22a2a..0563dbcd236 100644
--- a/packages/python/plotly/plotly/graph_objs/__init__.py
+++ b/packages/python/plotly/plotly/graph_objs/__init__.py
@@ -8,10 +8,12 @@
from ._candlestick import Candlestick
from ._carpet import Carpet
from ._choropleth import Choropleth
+ from ._choroplethmap import Choroplethmap
from ._choroplethmapbox import Choroplethmapbox
from ._cone import Cone
from ._contour import Contour
from ._contourcarpet import Contourcarpet
+ from ._densitymap import Densitymap
from ._densitymapbox import Densitymapbox
from ._deprecations import AngularAxis
from ._deprecations import Annotation
@@ -64,6 +66,7 @@
from ._scattercarpet import Scattercarpet
from ._scattergeo import Scattergeo
from ._scattergl import Scattergl
+ from ._scattermap import Scattermap
from ._scattermapbox import Scattermapbox
from ._scatterpolar import Scatterpolar
from ._scatterpolargl import Scatterpolargl
@@ -84,10 +87,12 @@
from . import candlestick
from . import carpet
from . import choropleth
+ from . import choroplethmap
from . import choroplethmapbox
from . import cone
from . import contour
from . import contourcarpet
+ from . import densitymap
from . import densitymapbox
from . import funnel
from . import funnelarea
@@ -113,6 +118,7 @@
from . import scattercarpet
from . import scattergeo
from . import scattergl
+ from . import scattermap
from . import scattermapbox
from . import scatterpolar
from . import scatterpolargl
@@ -139,10 +145,12 @@
".candlestick",
".carpet",
".choropleth",
+ ".choroplethmap",
".choroplethmapbox",
".cone",
".contour",
".contourcarpet",
+ ".densitymap",
".densitymapbox",
".funnel",
".funnelarea",
@@ -168,6 +176,7 @@
".scattercarpet",
".scattergeo",
".scattergl",
+ ".scattermap",
".scattermapbox",
".scatterpolar",
".scatterpolargl",
@@ -190,10 +199,12 @@
"._candlestick.Candlestick",
"._carpet.Carpet",
"._choropleth.Choropleth",
+ "._choroplethmap.Choroplethmap",
"._choroplethmapbox.Choroplethmapbox",
"._cone.Cone",
"._contour.Contour",
"._contourcarpet.Contourcarpet",
+ "._densitymap.Densitymap",
"._densitymapbox.Densitymapbox",
"._deprecations.AngularAxis",
"._deprecations.Annotation",
@@ -246,6 +257,7 @@
"._scattercarpet.Scattercarpet",
"._scattergeo.Scattergeo",
"._scattergl.Scattergl",
+ "._scattermap.Scattermap",
"._scattermapbox.Scattermapbox",
"._scatterpolar.Scatterpolar",
"._scatterpolargl.Scatterpolargl",
diff --git a/packages/python/plotly/plotly/graph_objs/_choroplethmap.py b/packages/python/plotly/plotly/graph_objs/_choroplethmap.py
new file mode 100644
index 00000000000..66640989bb4
--- /dev/null
+++ b/packages/python/plotly/plotly/graph_objs/_choroplethmap.py
@@ -0,0 +1,2376 @@
+from plotly.basedatatypes import BaseTraceType as _BaseTraceType
+import copy as _copy
+
+
+class Choroplethmap(_BaseTraceType):
+
+ # class properties
+ # --------------------
+ _parent_path_str = ""
+ _path_str = "choroplethmap"
+ _valid_props = {
+ "autocolorscale",
+ "below",
+ "coloraxis",
+ "colorbar",
+ "colorscale",
+ "customdata",
+ "customdatasrc",
+ "featureidkey",
+ "geojson",
+ "hoverinfo",
+ "hoverinfosrc",
+ "hoverlabel",
+ "hovertemplate",
+ "hovertemplatesrc",
+ "hovertext",
+ "hovertextsrc",
+ "ids",
+ "idssrc",
+ "legend",
+ "legendgroup",
+ "legendgrouptitle",
+ "legendrank",
+ "legendwidth",
+ "locations",
+ "locationssrc",
+ "marker",
+ "meta",
+ "metasrc",
+ "name",
+ "reversescale",
+ "selected",
+ "selectedpoints",
+ "showlegend",
+ "showscale",
+ "stream",
+ "subplot",
+ "text",
+ "textsrc",
+ "type",
+ "uid",
+ "uirevision",
+ "unselected",
+ "visible",
+ "z",
+ "zauto",
+ "zmax",
+ "zmid",
+ "zmin",
+ "zsrc",
+ }
+
+ # autocolorscale
+ # --------------
+ @property
+ def autocolorscale(self):
+ """
+ Determines whether the colorscale is a default palette
+ (`autocolorscale: true`) or the palette determined by
+ `colorscale`. In case `colorscale` is unspecified or
+ `autocolorscale` is true, the default palette will be chosen
+ according to whether numbers in the `color` array are all
+ positive, all negative or mixed.
+
+ The 'autocolorscale' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["autocolorscale"]
+
+ @autocolorscale.setter
+ def autocolorscale(self, val):
+ self["autocolorscale"] = val
+
+ # below
+ # -----
+ @property
+ def below(self):
+ """
+ Determines if the choropleth polygons will be inserted before
+ the layer with the specified ID. By default, choroplethmap
+ traces are placed above the water layers. If set to '', the
+ layer will be inserted above every existing layer.
+
+ The 'below' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["below"]
+
+ @below.setter
+ def below(self, val):
+ self["below"] = val
+
+ # coloraxis
+ # ---------
+ @property
+ def coloraxis(self):
+ """
+ Sets a reference to a shared color axis. References to these
+ shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
+ etc. Settings for these shared color axes are set in the
+ layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
+ Note that multiple color scales can be linked to the same color
+ axis.
+
+ The 'coloraxis' property is an identifier of a particular
+ subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
+ optionally followed by an integer >= 1
+ (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
+
+ Returns
+ -------
+ str
+ """
+ return self["coloraxis"]
+
+ @coloraxis.setter
+ def coloraxis(self, val):
+ self["coloraxis"] = val
+
+ # colorbar
+ # --------
+ @property
+ def colorbar(self):
+ """
+ The 'colorbar' property is an instance of ColorBar
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.choroplethmap.ColorBar`
+ - A dict of string/value properties that will be passed
+ to the ColorBar constructor
+
+ Supported dict properties:
+
+ bgcolor
+ Sets the color of padded area.
+ bordercolor
+ Sets the axis line color.
+ borderwidth
+ Sets the width (in px) or the border enclosing
+ this color bar.
+ dtick
+ Sets the step in-between ticks on this axis.
+ Use with `tick0`. Must be a positive number, or
+ special strings available to "log" and "date"
+ axes. If the axis `type` is "log", then ticks
+ are set every 10^(n*dtick) where n is the tick
+ number. For example, to set a tick mark at 1,
+ 10, 100, 1000, ... set dtick to 1. To set tick
+ marks at 1, 100, 10000, ... set dtick to 2. To
+ set tick marks at 1, 5, 25, 125, 625, 3125, ...
+ set dtick to log_10(5), or 0.69897000433. "log"
+ has several special values; "L", where `f`
+ is a positive number, gives ticks linearly
+ spaced in value (but not position). For example
+ `tick0` = 0.1, `dtick` = "L0.5" will put ticks
+ at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
+ plus small digits between, use "D1" (all
+ digits) or "D2" (only 2 and 5). `tick0` is
+ ignored for "D1" and "D2". If the axis `type`
+ is "date", then you must convert the time to
+ milliseconds. For example, to set the interval
+ between ticks to one day, set `dtick` to
+ 86400000.0. "date" also has special values
+ "M" gives ticks spaced by a number of
+ months. `n` must be a positive integer. To set
+ ticks on the 15th of every third month, set
+ `tick0` to "2000-01-15" and `dtick` to "M3". To
+ set ticks every 4 years, set `dtick` to "M48"
+ exponentformat
+ Determines a formatting rule for the tick
+ exponents. For example, consider the number
+ 1,000,000,000. If "none", it appears as
+ 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
+ "power", 1x10^9 (with 9 in a super script). If
+ "SI", 1G. If "B", 1B.
+ labelalias
+ Replacement text for specific tick or hover
+ labels. For example using {US: 'USA', CA:
+ 'Canada'} changes US to USA and CA to Canada.
+ The labels we would have shown must match the
+ keys exactly, after adding any tickprefix or
+ ticksuffix. For negative numbers the minus sign
+ symbol used (U+2212) is wider than the regular
+ ascii dash. That means you need to use −1
+ instead of -1. labelalias can be used with any
+ axis type, and both keys (if needed) and values
+ (if desired) can include html-like tags or
+ MathJax.
+ len
+ Sets the length of the color bar This measure
+ excludes the padding of both ends. That is, the
+ color bar length is this length minus the
+ padding on both ends.
+ lenmode
+ Determines whether this color bar's length
+ (i.e. the measure in the color variation
+ direction) is set in units of plot "fraction"
+ or in *pixels. Use `len` to set the value.
+ minexponent
+ Hide SI prefix for 10^n if |n| is below this
+ number. This only has an effect when
+ `tickformat` is "SI" or "B".
+ nticks
+ Specifies the maximum number of ticks for the
+ particular axis. The actual number of ticks
+ will be chosen automatically to be less than or
+ equal to `nticks`. Has an effect only if
+ `tickmode` is set to "auto".
+ orientation
+ Sets the orientation of the colorbar.
+ outlinecolor
+ Sets the axis line color.
+ outlinewidth
+ Sets the width (in px) of the axis line.
+ separatethousands
+ If "true", even 4-digit integers are separated
+ showexponent
+ If "all", all exponents are shown besides their
+ significands. If "first", only the exponent of
+ the first tick is shown. If "last", only the
+ exponent of the last tick is shown. If "none",
+ no exponents appear.
+ showticklabels
+ Determines whether or not the tick labels are
+ drawn.
+ showtickprefix
+ If "all", all tick labels are displayed with a
+ prefix. If "first", only the first tick is
+ displayed with a prefix. If "last", only the
+ last tick is displayed with a suffix. If
+ "none", tick prefixes are hidden.
+ showticksuffix
+ Same as `showtickprefix` but for tick suffixes.
+ thickness
+ Sets the thickness of the color bar This
+ measure excludes the size of the padding, ticks
+ and labels.
+ thicknessmode
+ Determines whether this color bar's thickness
+ (i.e. the measure in the constant color
+ direction) is set in units of plot "fraction"
+ or in "pixels". Use `thickness` to set the
+ value.
+ tick0
+ Sets the placement of the first tick on this
+ axis. Use with `dtick`. If the axis `type` is
+ "log", then you must take the log of your
+ starting tick (e.g. to set the starting tick to
+ 100, set the `tick0` to 2) except when
+ `dtick`=*L* (see `dtick` for more info). If
+ the axis `type` is "date", it should be a date
+ string, like date data. If the axis `type` is
+ "category", it should be a number, using the
+ scale where each category is assigned a serial
+ number from zero in the order it appears.
+ tickangle
+ Sets the angle of the tick labels with respect
+ to the horizontal. For example, a `tickangle`
+ of -90 draws the tick labels vertically.
+ tickcolor
+ Sets the tick color.
+ tickfont
+ Sets the color bar's tick label font
+ tickformat
+ Sets the tick label formatting rule using d3
+ formatting mini-languages which are very
+ similar to those in Python. For numbers, see: h
+ ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
+ format. And for dates see:
+ https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format. We add two
+ items to d3's date formatter: "%h" for half of
+ the year as a decimal number as well as "%{n}f"
+ for fractional seconds with n digits. For
+ example, *2016-10-13 09:15:23.456* with
+ tickformat "%H~%M~%S.%2f" would display
+ "09~15~23.46"
+ tickformatstops
+ A tuple of :class:`plotly.graph_objects.choropl
+ ethmap.colorbar.Tickformatstop` instances or
+ dicts with compatible properties
+ tickformatstopdefaults
+ When used in a template (as layout.template.dat
+ a.choroplethmap.colorbar.tickformatstopdefaults
+ ), sets the default property values to use for
+ elements of
+ choroplethmap.colorbar.tickformatstops
+ ticklabeloverflow
+ Determines how we handle tick labels that would
+ overflow either the graph div or the domain of
+ the axis. The default value for inside tick
+ labels is *hide past domain*. In other cases
+ the default is *hide past div*.
+ ticklabelposition
+ Determines where tick labels are drawn relative
+ to the ticks. Left and right options are used
+ when `orientation` is "h", top and bottom when
+ `orientation` is "v".
+ ticklabelstep
+ Sets the spacing between tick labels as
+ compared to the spacing between ticks. A value
+ of 1 (default) means each tick gets a label. A
+ value of 2 means shows every 2nd label. A
+ larger value n means only every nth tick is
+ labeled. `tick0` determines which labels are
+ shown. Not implemented for axes with `type`
+ "log" or "multicategory", or when `tickmode` is
+ "array".
+ ticklen
+ Sets the tick length (in px).
+ tickmode
+ Sets the tick mode for this axis. If "auto",
+ the number of ticks is set via `nticks`. If
+ "linear", the placement of the ticks is
+ determined by a starting position `tick0` and a
+ tick step `dtick` ("linear" is the default
+ value if `tick0` and `dtick` are provided). If
+ "array", the placement of the ticks is set via
+ `tickvals` and the tick text is `ticktext`.
+ ("array" is the default value if `tickvals` is
+ provided).
+ tickprefix
+ Sets a tick label prefix.
+ ticks
+ Determines whether ticks are drawn or not. If
+ "", this axis' ticks are not drawn. If
+ "outside" ("inside"), this axis' are drawn
+ outside (inside) the axis lines.
+ ticksuffix
+ Sets a tick label suffix.
+ ticktext
+ Sets the text displayed at the ticks position
+ via `tickvals`. Only has an effect if
+ `tickmode` is set to "array". Used with
+ `tickvals`.
+ ticktextsrc
+ Sets the source reference on Chart Studio Cloud
+ for `ticktext`.
+ tickvals
+ Sets the values at which ticks on this axis
+ appear. Only has an effect if `tickmode` is set
+ to "array". Used with `ticktext`.
+ tickvalssrc
+ Sets the source reference on Chart Studio Cloud
+ for `tickvals`.
+ tickwidth
+ Sets the tick width (in px).
+ title
+ :class:`plotly.graph_objects.choroplethmap.colo
+ rbar.Title` instance or dict with compatible
+ properties
+ titlefont
+ Deprecated: Please use
+ choroplethmap.colorbar.title.font instead. Sets
+ this color bar's title font. Note that the
+ title's font used to be set by the now
+ deprecated `titlefont` attribute.
+ titleside
+ Deprecated: Please use
+ choroplethmap.colorbar.title.side instead.
+ Determines the location of color bar's title
+ with respect to the color bar. Defaults to
+ "top" when `orientation` if "v" and defaults
+ to "right" when `orientation` if "h". Note that
+ the title's location used to be set by the now
+ deprecated `titleside` attribute.
+ x
+ Sets the x position with respect to `xref` of
+ the color bar (in plot fraction). When `xref`
+ is "paper", defaults to 1.02 when `orientation`
+ is "v" and 0.5 when `orientation` is "h". When
+ `xref` is "container", defaults to 1 when
+ `orientation` is "v" and 0.5 when `orientation`
+ is "h". Must be between 0 and 1 if `xref` is
+ "container" and between "-2" and 3 if `xref` is
+ "paper".
+ xanchor
+ Sets this color bar's horizontal position
+ anchor. This anchor binds the `x` position to
+ the "left", "center" or "right" of the color
+ bar. Defaults to "left" when `orientation` is
+ "v" and "center" when `orientation` is "h".
+ xpad
+ Sets the amount of padding (in px) along the x
+ direction.
+ xref
+ Sets the container `x` refers to. "container"
+ spans the entire `width` of the plot. "paper"
+ refers to the width of the plotting area only.
+ y
+ Sets the y position with respect to `yref` of
+ the color bar (in plot fraction). When `yref`
+ is "paper", defaults to 0.5 when `orientation`
+ is "v" and 1.02 when `orientation` is "h". When
+ `yref` is "container", defaults to 0.5 when
+ `orientation` is "v" and 1 when `orientation`
+ is "h". Must be between 0 and 1 if `yref` is
+ "container" and between "-2" and 3 if `yref` is
+ "paper".
+ yanchor
+ Sets this color bar's vertical position anchor
+ This anchor binds the `y` position to the
+ "top", "middle" or "bottom" of the color bar.
+ Defaults to "middle" when `orientation` is "v"
+ and "bottom" when `orientation` is "h".
+ ypad
+ Sets the amount of padding (in px) along the y
+ direction.
+ yref
+ Sets the container `y` refers to. "container"
+ spans the entire `height` of the plot. "paper"
+ refers to the height of the plotting area only.
+
+ Returns
+ -------
+ plotly.graph_objs.choroplethmap.ColorBar
+ """
+ return self["colorbar"]
+
+ @colorbar.setter
+ def colorbar(self, val):
+ self["colorbar"] = val
+
+ # colorscale
+ # ----------
+ @property
+ def colorscale(self):
+ """
+ Sets the colorscale. The colorscale must be an array containing
+ arrays mapping a normalized value to an rgb, rgba, hex, hsl,
+ hsv, or named color string. At minimum, a mapping for the
+ lowest (0) and highest (1) values are required. For example,
+ `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
+ bounds of the colorscale in color space, use `zmin` and `zmax`.
+ Alternatively, `colorscale` may be a palette name string of the
+ following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
+ Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
+ YlGnBu,YlOrRd.
+
+ The 'colorscale' property is a colorscale and may be
+ specified as:
+ - A list of colors that will be spaced evenly to create the colorscale.
+ Many predefined colorscale lists are included in the sequential, diverging,
+ and cyclical modules in the plotly.colors package.
+ - A list of 2-element lists where the first element is the
+ normalized color level value (starting at 0 and ending at 1),
+ and the second item is a valid color string.
+ (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
+ - One of the following named colorscales:
+ ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
+ 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
+ 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
+ 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
+ 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
+ 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
+ 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
+ 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
+ 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
+ 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
+ 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
+ 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
+ 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
+ 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
+ 'ylorrd'].
+ Appending '_r' to a named colorscale reverses it.
+
+ Returns
+ -------
+ str
+ """
+ return self["colorscale"]
+
+ @colorscale.setter
+ def colorscale(self, val):
+ self["colorscale"] = val
+
+ # customdata
+ # ----------
+ @property
+ def customdata(self):
+ """
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note that,
+ "scatter" traces also appends customdata items in the markers
+ DOM elements
+
+ The 'customdata' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["customdata"]
+
+ @customdata.setter
+ def customdata(self, val):
+ self["customdata"] = val
+
+ # customdatasrc
+ # -------------
+ @property
+ def customdatasrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+
+ The 'customdatasrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["customdatasrc"]
+
+ @customdatasrc.setter
+ def customdatasrc(self, val):
+ self["customdatasrc"] = val
+
+ # featureidkey
+ # ------------
+ @property
+ def featureidkey(self):
+ """
+ Sets the key in GeoJSON features which is used as id to match
+ the items included in the `locations` array. Support nested
+ property, for example "properties.name".
+
+ The 'featureidkey' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["featureidkey"]
+
+ @featureidkey.setter
+ def featureidkey(self, val):
+ self["featureidkey"] = val
+
+ # geojson
+ # -------
+ @property
+ def geojson(self):
+ """
+ Sets the GeoJSON data associated with this trace. It can be set
+ as a valid GeoJSON object or as a URL string. Note that we only
+ accept GeoJSONs of type "FeatureCollection" or "Feature" with
+ geometries of type "Polygon" or "MultiPolygon".
+
+ The 'geojson' property accepts values of any type
+
+ Returns
+ -------
+ Any
+ """
+ return self["geojson"]
+
+ @geojson.setter
+ def geojson(self, val):
+ self["geojson"] = val
+
+ # hoverinfo
+ # ---------
+ @property
+ def hoverinfo(self):
+ """
+ Determines which trace information appear on hover. If `none`
+ or `skip` are set, no information is displayed upon hovering.
+ But, if `none` is set, click and hover events are still fired.
+
+ The 'hoverinfo' property is a flaglist and may be specified
+ as a string containing:
+ - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters
+ (e.g. 'location+z')
+ OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
+ - A list or array of the above
+
+ Returns
+ -------
+ Any|numpy.ndarray
+ """
+ return self["hoverinfo"]
+
+ @hoverinfo.setter
+ def hoverinfo(self, val):
+ self["hoverinfo"] = val
+
+ # hoverinfosrc
+ # ------------
+ @property
+ def hoverinfosrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+
+ The 'hoverinfosrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["hoverinfosrc"]
+
+ @hoverinfosrc.setter
+ def hoverinfosrc(self, val):
+ self["hoverinfosrc"] = val
+
+ # hoverlabel
+ # ----------
+ @property
+ def hoverlabel(self):
+ """
+ The 'hoverlabel' property is an instance of Hoverlabel
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.choroplethmap.Hoverlabel`
+ - A dict of string/value properties that will be passed
+ to the Hoverlabel constructor
+
+ Supported dict properties:
+
+ align
+ Sets the horizontal alignment of the text
+ content within hover label box. Has an effect
+ only if the hover label text spans more two or
+ more lines
+ alignsrc
+ Sets the source reference on Chart Studio Cloud
+ for `align`.
+ bgcolor
+ Sets the background color of the hover labels
+ for this trace
+ bgcolorsrc
+ Sets the source reference on Chart Studio Cloud
+ for `bgcolor`.
+ bordercolor
+ Sets the border color of the hover labels for
+ this trace.
+ bordercolorsrc
+ Sets the source reference on Chart Studio Cloud
+ for `bordercolor`.
+ font
+ Sets the font used in hover labels.
+ namelength
+ Sets the default length (in number of
+ characters) of the trace name in the hover
+ labels for all traces. -1 shows the whole name
+ regardless of length. 0-3 shows the first 0-3
+ characters, and an integer >3 will show the
+ whole name if it is less than that many
+ characters, but if it is longer, will truncate
+ to `namelength - 3` characters and add an
+ ellipsis.
+ namelengthsrc
+ Sets the source reference on Chart Studio Cloud
+ for `namelength`.
+
+ Returns
+ -------
+ plotly.graph_objs.choroplethmap.Hoverlabel
+ """
+ return self["hoverlabel"]
+
+ @hoverlabel.setter
+ def hoverlabel(self, val):
+ self["hoverlabel"] = val
+
+ # hovertemplate
+ # -------------
+ @property
+ def hovertemplate(self):
+ """
+ Template string used for rendering the information that appear
+ on hover box. Note that this will override `hoverinfo`.
+ Variables are inserted using %{variable}, for example "y: %{y}"
+ as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
+ showing info for several points, "xother" will be added to
+ those with different x positions from the first point. An
+ underscore before or after "(x|y)other" will add a space on
+ that side, only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for example
+ "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
+ details on the formatting syntax. Dates are formatted using
+ d3-time-format's syntax %{variable|d3-time-format}, for example
+ "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the date
+ formatting syntax. The variables available in `hovertemplate`
+ are the ones emitted as event data described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-data.
+ Additionally, every attributes that can be specified per-point
+ (the ones that are `arrayOk: true`) are available. Finally, the
+ template string has access to variable `properties` Anything
+ contained in tag `` is displayed in the secondary box,
+ for example "{fullData.name}". To hide the
+ secondary box completely, use an empty tag ``.
+
+ The 'hovertemplate' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+ - A tuple, list, or one-dimensional numpy array of the above
+
+ Returns
+ -------
+ str|numpy.ndarray
+ """
+ return self["hovertemplate"]
+
+ @hovertemplate.setter
+ def hovertemplate(self, val):
+ self["hovertemplate"] = val
+
+ # hovertemplatesrc
+ # ----------------
+ @property
+ def hovertemplatesrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+
+ The 'hovertemplatesrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["hovertemplatesrc"]
+
+ @hovertemplatesrc.setter
+ def hovertemplatesrc(self, val):
+ self["hovertemplatesrc"] = val
+
+ # hovertext
+ # ---------
+ @property
+ def hovertext(self):
+ """
+ Same as `text`.
+
+ The 'hovertext' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+ - A tuple, list, or one-dimensional numpy array of the above
+
+ Returns
+ -------
+ str|numpy.ndarray
+ """
+ return self["hovertext"]
+
+ @hovertext.setter
+ def hovertext(self, val):
+ self["hovertext"] = val
+
+ # hovertextsrc
+ # ------------
+ @property
+ def hovertextsrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
+
+ The 'hovertextsrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["hovertextsrc"]
+
+ @hovertextsrc.setter
+ def hovertextsrc(self, val):
+ self["hovertextsrc"] = val
+
+ # ids
+ # ---
+ @property
+ def ids(self):
+ """
+ Assigns id labels to each datum. These ids for object constancy
+ of data points during animation. Should be an array of strings,
+ not numbers or any other type.
+
+ The 'ids' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["ids"]
+
+ @ids.setter
+ def ids(self, val):
+ self["ids"] = val
+
+ # idssrc
+ # ------
+ @property
+ def idssrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `ids`.
+
+ The 'idssrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["idssrc"]
+
+ @idssrc.setter
+ def idssrc(self, val):
+ self["idssrc"] = val
+
+ # legend
+ # ------
+ @property
+ def legend(self):
+ """
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2", "legend3",
+ etc. Settings for these legends are set in the layout, under
+ `layout.legend`, `layout.legend2`, etc.
+
+ The 'legend' property is an identifier of a particular
+ subplot, of type 'legend', that may be specified as the string 'legend'
+ optionally followed by an integer >= 1
+ (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
+
+ Returns
+ -------
+ str
+ """
+ return self["legend"]
+
+ @legend.setter
+ def legend(self, val):
+ self["legend"] = val
+
+ # legendgroup
+ # -----------
+ @property
+ def legendgroup(self):
+ """
+ Sets the legend group for this trace. Traces and shapes part of
+ the same legend group hide/show at the same time when toggling
+ legend items.
+
+ The 'legendgroup' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["legendgroup"]
+
+ @legendgroup.setter
+ def legendgroup(self, val):
+ self["legendgroup"] = val
+
+ # legendgrouptitle
+ # ----------------
+ @property
+ def legendgrouptitle(self):
+ """
+ The 'legendgrouptitle' property is an instance of Legendgrouptitle
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.choroplethmap.Legendgrouptitle`
+ - A dict of string/value properties that will be passed
+ to the Legendgrouptitle constructor
+
+ Supported dict properties:
+
+ font
+ Sets this legend group's title font.
+ text
+ Sets the title of the legend group.
+
+ Returns
+ -------
+ plotly.graph_objs.choroplethmap.Legendgrouptitle
+ """
+ return self["legendgrouptitle"]
+
+ @legendgrouptitle.setter
+ def legendgrouptitle(self, val):
+ self["legendgrouptitle"] = val
+
+ # legendrank
+ # ----------
+ @property
+ def legendrank(self):
+ """
+ Sets the legend rank for this trace. Items and groups with
+ smaller ranks are presented on top/left side while with
+ "reversed" `legend.traceorder` they are on bottom/right side.
+ The default legendrank is 1000, so that you can use ranks less
+ than 1000 to place certain items before all unranked items, and
+ ranks greater than 1000 to go after all unranked items. When
+ having unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and layout.
+
+ The 'legendrank' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ int|float
+ """
+ return self["legendrank"]
+
+ @legendrank.setter
+ def legendrank(self, val):
+ self["legendrank"] = val
+
+ # legendwidth
+ # -----------
+ @property
+ def legendwidth(self):
+ """
+ Sets the width (in px or fraction) of the legend for this
+ trace.
+
+ The 'legendwidth' property is a number and may be specified as:
+ - An int or float in the interval [0, inf]
+
+ Returns
+ -------
+ int|float
+ """
+ return self["legendwidth"]
+
+ @legendwidth.setter
+ def legendwidth(self, val):
+ self["legendwidth"] = val
+
+ # locations
+ # ---------
+ @property
+ def locations(self):
+ """
+ Sets which features found in "geojson" to plot using their
+ feature `id` field.
+
+ The 'locations' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["locations"]
+
+ @locations.setter
+ def locations(self, val):
+ self["locations"] = val
+
+ # locationssrc
+ # ------------
+ @property
+ def locationssrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `locations`.
+
+ The 'locationssrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["locationssrc"]
+
+ @locationssrc.setter
+ def locationssrc(self, val):
+ self["locationssrc"] = val
+
+ # marker
+ # ------
+ @property
+ def marker(self):
+ """
+ The 'marker' property is an instance of Marker
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.choroplethmap.Marker`
+ - A dict of string/value properties that will be passed
+ to the Marker constructor
+
+ Supported dict properties:
+
+ line
+ :class:`plotly.graph_objects.choroplethmap.mark
+ er.Line` instance or dict with compatible
+ properties
+ opacity
+ Sets the opacity of the locations.
+ opacitysrc
+ Sets the source reference on Chart Studio Cloud
+ for `opacity`.
+
+ Returns
+ -------
+ plotly.graph_objs.choroplethmap.Marker
+ """
+ return self["marker"]
+
+ @marker.setter
+ def marker(self, val):
+ self["marker"] = val
+
+ # meta
+ # ----
+ @property
+ def meta(self):
+ """
+ Assigns extra meta information associated with this trace that
+ can be used in various text attributes. Attributes such as
+ trace `name`, graph, axis and colorbar `title.text`, annotation
+ `text` `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta` values in
+ an attribute in the same trace, simply use `%{meta[i]}` where
+ `i` is the index or key of the `meta` item in question. To
+ access trace `meta` in layout attributes, use
+ `%{data[n[.meta[i]}` where `i` is the index or key of the
+ `meta` and `n` is the trace index.
+
+ The 'meta' property accepts values of any type
+
+ Returns
+ -------
+ Any|numpy.ndarray
+ """
+ return self["meta"]
+
+ @meta.setter
+ def meta(self, val):
+ self["meta"] = val
+
+ # metasrc
+ # -------
+ @property
+ def metasrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `meta`.
+
+ The 'metasrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["metasrc"]
+
+ @metasrc.setter
+ def metasrc(self, val):
+ self["metasrc"] = val
+
+ # name
+ # ----
+ @property
+ def name(self):
+ """
+ Sets the trace name. The trace name appears as the legend item
+ and on hover.
+
+ The 'name' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["name"]
+
+ @name.setter
+ def name(self, val):
+ self["name"] = val
+
+ # reversescale
+ # ------------
+ @property
+ def reversescale(self):
+ """
+ Reverses the color mapping if true. If true, `zmin` will
+ correspond to the last color in the array and `zmax` will
+ correspond to the first color.
+
+ The 'reversescale' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["reversescale"]
+
+ @reversescale.setter
+ def reversescale(self, val):
+ self["reversescale"] = val
+
+ # selected
+ # --------
+ @property
+ def selected(self):
+ """
+ The 'selected' property is an instance of Selected
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.choroplethmap.Selected`
+ - A dict of string/value properties that will be passed
+ to the Selected constructor
+
+ Supported dict properties:
+
+ marker
+ :class:`plotly.graph_objects.choroplethmap.sele
+ cted.Marker` instance or dict with compatible
+ properties
+
+ Returns
+ -------
+ plotly.graph_objs.choroplethmap.Selected
+ """
+ return self["selected"]
+
+ @selected.setter
+ def selected(self, val):
+ self["selected"] = val
+
+ # selectedpoints
+ # --------------
+ @property
+ def selectedpoints(self):
+ """
+ Array containing integer indices of selected points. Has an
+ effect only for traces that support selections. Note that an
+ empty array means an empty selection where the `unselected` are
+ turned on for all points, whereas, any other non-array values
+ means no selection all where the `selected` and `unselected`
+ styles have no effect.
+
+ The 'selectedpoints' property accepts values of any type
+
+ Returns
+ -------
+ Any
+ """
+ return self["selectedpoints"]
+
+ @selectedpoints.setter
+ def selectedpoints(self, val):
+ self["selectedpoints"] = val
+
+ # showlegend
+ # ----------
+ @property
+ def showlegend(self):
+ """
+ Determines whether or not an item corresponding to this trace
+ is shown in the legend.
+
+ The 'showlegend' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["showlegend"]
+
+ @showlegend.setter
+ def showlegend(self, val):
+ self["showlegend"] = val
+
+ # showscale
+ # ---------
+ @property
+ def showscale(self):
+ """
+ Determines whether or not a colorbar is displayed for this
+ trace.
+
+ The 'showscale' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["showscale"]
+
+ @showscale.setter
+ def showscale(self, val):
+ self["showscale"] = val
+
+ # stream
+ # ------
+ @property
+ def stream(self):
+ """
+ The 'stream' property is an instance of Stream
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.choroplethmap.Stream`
+ - A dict of string/value properties that will be passed
+ to the Stream constructor
+
+ Supported dict properties:
+
+ maxpoints
+ Sets the maximum number of points to keep on
+ the plots from an incoming stream. If
+ `maxpoints` is set to 50, only the newest 50
+ points will be displayed on the plot.
+ token
+ The stream id number links a data trace on a
+ plot with a stream. See https://chart-
+ studio.plotly.com/settings for more details.
+
+ Returns
+ -------
+ plotly.graph_objs.choroplethmap.Stream
+ """
+ return self["stream"]
+
+ @stream.setter
+ def stream(self, val):
+ self["stream"] = val
+
+ # subplot
+ # -------
+ @property
+ def subplot(self):
+ """
+ Sets a reference between this trace's data coordinates and a
+ map subplot. If "map" (the default value), the data refer to
+ `layout.map`. If "map2", the data refer to `layout.map2`, and
+ so on.
+
+ The 'subplot' property is an identifier of a particular
+ subplot, of type 'map', that may be specified as the string 'map'
+ optionally followed by an integer >= 1
+ (e.g. 'map', 'map1', 'map2', 'map3', etc.)
+
+ Returns
+ -------
+ str
+ """
+ return self["subplot"]
+
+ @subplot.setter
+ def subplot(self, val):
+ self["subplot"] = val
+
+ # text
+ # ----
+ @property
+ def text(self):
+ """
+ Sets the text elements associated with each location.
+
+ The 'text' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+ - A tuple, list, or one-dimensional numpy array of the above
+
+ Returns
+ -------
+ str|numpy.ndarray
+ """
+ return self["text"]
+
+ @text.setter
+ def text(self, val):
+ self["text"] = val
+
+ # textsrc
+ # -------
+ @property
+ def textsrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `text`.
+
+ The 'textsrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["textsrc"]
+
+ @textsrc.setter
+ def textsrc(self, val):
+ self["textsrc"] = val
+
+ # uid
+ # ---
+ @property
+ def uid(self):
+ """
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and transitions.
+
+ The 'uid' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["uid"]
+
+ @uid.setter
+ def uid(self, val):
+ self["uid"] = val
+
+ # uirevision
+ # ----------
+ @property
+ def uirevision(self):
+ """
+ Controls persistence of some user-driven changes to the trace:
+ `constraintrange` in `parcoords` traces, as well as some
+ `editable: true` modifications such as `name` and
+ `colorbar.title`. Defaults to `layout.uirevision`. Note that
+ other user-driven trace attribute changes are controlled by
+ `layout` attributes: `trace.visible` is controlled by
+ `layout.legend.uirevision`, `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
+ with `config: {editable: true}`) is controlled by
+ `layout.editrevision`. Trace changes are tracked by `uid`,
+ which only falls back on trace index if no `uid` is provided.
+ So if your app can add/remove traces before the end of the
+ `data` array, such that the same trace has a different index,
+ you can still preserve user-driven changes if you give each
+ trace a `uid` that stays with it as it moves.
+
+ The 'uirevision' property accepts values of any type
+
+ Returns
+ -------
+ Any
+ """
+ return self["uirevision"]
+
+ @uirevision.setter
+ def uirevision(self, val):
+ self["uirevision"] = val
+
+ # unselected
+ # ----------
+ @property
+ def unselected(self):
+ """
+ The 'unselected' property is an instance of Unselected
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.choroplethmap.Unselected`
+ - A dict of string/value properties that will be passed
+ to the Unselected constructor
+
+ Supported dict properties:
+
+ marker
+ :class:`plotly.graph_objects.choroplethmap.unse
+ lected.Marker` instance or dict with compatible
+ properties
+
+ Returns
+ -------
+ plotly.graph_objs.choroplethmap.Unselected
+ """
+ return self["unselected"]
+
+ @unselected.setter
+ def unselected(self, val):
+ self["unselected"] = val
+
+ # visible
+ # -------
+ @property
+ def visible(self):
+ """
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as a
+ legend item (provided that the legend itself is visible).
+
+ The 'visible' property is an enumeration that may be specified as:
+ - One of the following enumeration values:
+ [True, False, 'legendonly']
+
+ Returns
+ -------
+ Any
+ """
+ return self["visible"]
+
+ @visible.setter
+ def visible(self, val):
+ self["visible"] = val
+
+ # z
+ # -
+ @property
+ def z(self):
+ """
+ Sets the color values.
+
+ The 'z' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["z"]
+
+ @z.setter
+ def z(self, val):
+ self["z"] = val
+
+ # zauto
+ # -----
+ @property
+ def zauto(self):
+ """
+ Determines whether or not the color domain is computed with
+ respect to the input data (here in `z`) or the bounds set in
+ `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
+ are set by the user.
+
+ The 'zauto' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["zauto"]
+
+ @zauto.setter
+ def zauto(self, val):
+ self["zauto"] = val
+
+ # zmax
+ # ----
+ @property
+ def zmax(self):
+ """
+ Sets the upper bound of the color domain. Value should have the
+ same units as in `z` and if set, `zmin` must be set as well.
+
+ The 'zmax' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ int|float
+ """
+ return self["zmax"]
+
+ @zmax.setter
+ def zmax(self, val):
+ self["zmax"] = val
+
+ # zmid
+ # ----
+ @property
+ def zmid(self):
+ """
+ Sets the mid-point of the color domain by scaling `zmin` and/or
+ `zmax` to be equidistant to this point. Value should have the
+ same units as in `z`. Has no effect when `zauto` is `false`.
+
+ The 'zmid' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ int|float
+ """
+ return self["zmid"]
+
+ @zmid.setter
+ def zmid(self, val):
+ self["zmid"] = val
+
+ # zmin
+ # ----
+ @property
+ def zmin(self):
+ """
+ Sets the lower bound of the color domain. Value should have the
+ same units as in `z` and if set, `zmax` must be set as well.
+
+ The 'zmin' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ int|float
+ """
+ return self["zmin"]
+
+ @zmin.setter
+ def zmin(self, val):
+ self["zmin"] = val
+
+ # zsrc
+ # ----
+ @property
+ def zsrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `z`.
+
+ The 'zsrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["zsrc"]
+
+ @zsrc.setter
+ def zsrc(self, val):
+ self["zsrc"] = val
+
+ # type
+ # ----
+ @property
+ def type(self):
+ return self._props["type"]
+
+ # Self properties description
+ # ---------------------------
+ @property
+ def _prop_descriptions(self):
+ return """\
+ autocolorscale
+ Determines whether the colorscale is a default palette
+ (`autocolorscale: true`) or the palette determined by
+ `colorscale`. In case `colorscale` is unspecified or
+ `autocolorscale` is true, the default palette will be
+ chosen according to whether numbers in the `color`
+ array are all positive, all negative or mixed.
+ below
+ Determines if the choropleth polygons will be inserted
+ before the layer with the specified ID. By default,
+ choroplethmap traces are placed above the water layers.
+ If set to '', the layer will be inserted above every
+ existing layer.
+ coloraxis
+ Sets a reference to a shared color axis. References to
+ these shared color axes are "coloraxis", "coloraxis2",
+ "coloraxis3", etc. Settings for these shared color axes
+ are set in the layout, under `layout.coloraxis`,
+ `layout.coloraxis2`, etc. Note that multiple color
+ scales can be linked to the same color axis.
+ colorbar
+ :class:`plotly.graph_objects.choroplethmap.ColorBar`
+ instance or dict with compatible properties
+ colorscale
+ Sets the colorscale. The colorscale must be an array
+ containing arrays mapping a normalized value to an rgb,
+ rgba, hex, hsl, hsv, or named color string. At minimum,
+ a mapping for the lowest (0) and highest (1) values are
+ required. For example, `[[0, 'rgb(0,0,255)'], [1,
+ 'rgb(255,0,0)']]`. To control the bounds of the
+ colorscale in color space, use `zmin` and `zmax`.
+ Alternatively, `colorscale` may be a palette name
+ string of the following list: Blackbody,Bluered,Blues,C
+ ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
+ and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
+ customdata
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note
+ that, "scatter" traces also appends customdata items in
+ the markers DOM elements
+ customdatasrc
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+ featureidkey
+ Sets the key in GeoJSON features which is used as id to
+ match the items included in the `locations` array.
+ Support nested property, for example "properties.name".
+ geojson
+ Sets the GeoJSON data associated with this trace. It
+ can be set as a valid GeoJSON object or as a URL
+ string. Note that we only accept GeoJSONs of type
+ "FeatureCollection" or "Feature" with geometries of
+ type "Polygon" or "MultiPolygon".
+ hoverinfo
+ Determines which trace information appear on hover. If
+ `none` or `skip` are set, no information is displayed
+ upon hovering. But, if `none` is set, click and hover
+ events are still fired.
+ hoverinfosrc
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+ hoverlabel
+ :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
+ instance or dict with compatible properties
+ hovertemplate
+ Template string used for rendering the information that
+ appear on hover box. Note that this will override
+ `hoverinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}" as well as %{xother}, {%_xother},
+ {%_xother_}, {%xother_}. When showing info for several
+ points, "xother" will be added to those with different
+ x positions from the first point. An underscore before
+ or after "(x|y)other" will add a space on that side,
+ only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for
+ example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. The variables available in
+ `hovertemplate` are the ones emitted as event data
+ described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-
+ data. Additionally, every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Finally, the template string has access
+ to variable `properties` Anything contained in tag
+ `` is displayed in the secondary box, for
+ example "{fullData.name}". To hide the
+ secondary box completely, use an empty tag
+ ``.
+ hovertemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+ hovertext
+ Same as `text`.
+ hovertextsrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
+ ids
+ Assigns id labels to each datum. These ids for object
+ constancy of data points during animation. Should be an
+ array of strings, not numbers or any other type.
+ idssrc
+ Sets the source reference on Chart Studio Cloud for
+ `ids`.
+ legend
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2",
+ "legend3", etc. Settings for these legends are set in
+ the layout, under `layout.legend`, `layout.legend2`,
+ etc.
+ legendgroup
+ Sets the legend group for this trace. Traces and shapes
+ part of the same legend group hide/show at the same
+ time when toggling legend items.
+ legendgrouptitle
+ :class:`plotly.graph_objects.choroplethmap.Legendgroupt
+ itle` instance or dict with compatible properties
+ legendrank
+ Sets the legend rank for this trace. Items and groups
+ with smaller ranks are presented on top/left side while
+ with "reversed" `legend.traceorder` they are on
+ bottom/right side. The default legendrank is 1000, so
+ that you can use ranks less than 1000 to place certain
+ items before all unranked items, and ranks greater than
+ 1000 to go after all unranked items. When having
+ unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and
+ layout.
+ legendwidth
+ Sets the width (in px or fraction) of the legend for
+ this trace.
+ locations
+ Sets which features found in "geojson" to plot using
+ their feature `id` field.
+ locationssrc
+ Sets the source reference on Chart Studio Cloud for
+ `locations`.
+ marker
+ :class:`plotly.graph_objects.choroplethmap.Marker`
+ instance or dict with compatible properties
+ meta
+ Assigns extra meta information associated with this
+ trace that can be used in various text attributes.
+ Attributes such as trace `name`, graph, axis and
+ colorbar `title.text`, annotation `text`
+ `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta`
+ values in an attribute in the same trace, simply use
+ `%{meta[i]}` where `i` is the index or key of the
+ `meta` item in question. To access trace `meta` in
+ layout attributes, use `%{data[n[.meta[i]}` where `i`
+ is the index or key of the `meta` and `n` is the trace
+ index.
+ metasrc
+ Sets the source reference on Chart Studio Cloud for
+ `meta`.
+ name
+ Sets the trace name. The trace name appears as the
+ legend item and on hover.
+ reversescale
+ Reverses the color mapping if true. If true, `zmin`
+ will correspond to the last color in the array and
+ `zmax` will correspond to the first color.
+ selected
+ :class:`plotly.graph_objects.choroplethmap.Selected`
+ instance or dict with compatible properties
+ selectedpoints
+ Array containing integer indices of selected points.
+ Has an effect only for traces that support selections.
+ Note that an empty array means an empty selection where
+ the `unselected` are turned on for all points, whereas,
+ any other non-array values means no selection all where
+ the `selected` and `unselected` styles have no effect.
+ showlegend
+ Determines whether or not an item corresponding to this
+ trace is shown in the legend.
+ showscale
+ Determines whether or not a colorbar is displayed for
+ this trace.
+ stream
+ :class:`plotly.graph_objects.choroplethmap.Stream`
+ instance or dict with compatible properties
+ subplot
+ Sets a reference between this trace's data coordinates
+ and a map subplot. If "map" (the default value), the
+ data refer to `layout.map`. If "map2", the data refer
+ to `layout.map2`, and so on.
+ text
+ Sets the text elements associated with each location.
+ textsrc
+ Sets the source reference on Chart Studio Cloud for
+ `text`.
+ uid
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and
+ transitions.
+ uirevision
+ Controls persistence of some user-driven changes to the
+ trace: `constraintrange` in `parcoords` traces, as well
+ as some `editable: true` modifications such as `name`
+ and `colorbar.title`. Defaults to `layout.uirevision`.
+ Note that other user-driven trace attribute changes are
+ controlled by `layout` attributes: `trace.visible` is
+ controlled by `layout.legend.uirevision`,
+ `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)`
+ (accessible with `config: {editable: true}`) is
+ controlled by `layout.editrevision`. Trace changes are
+ tracked by `uid`, which only falls back on trace index
+ if no `uid` is provided. So if your app can add/remove
+ traces before the end of the `data` array, such that
+ the same trace has a different index, you can still
+ preserve user-driven changes if you give each trace a
+ `uid` that stays with it as it moves.
+ unselected
+ :class:`plotly.graph_objects.choroplethmap.Unselected`
+ instance or dict with compatible properties
+ visible
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as
+ a legend item (provided that the legend itself is
+ visible).
+ z
+ Sets the color values.
+ zauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here in `z`) or the
+ bounds set in `zmin` and `zmax` Defaults to `false`
+ when `zmin` and `zmax` are set by the user.
+ zmax
+ Sets the upper bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmin` must
+ be set as well.
+ zmid
+ Sets the mid-point of the color domain by scaling
+ `zmin` and/or `zmax` to be equidistant to this point.
+ Value should have the same units as in `z`. Has no
+ effect when `zauto` is `false`.
+ zmin
+ Sets the lower bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmax` must
+ be set as well.
+ zsrc
+ Sets the source reference on Chart Studio Cloud for
+ `z`.
+ """
+
+ def __init__(
+ self,
+ arg=None,
+ autocolorscale=None,
+ below=None,
+ coloraxis=None,
+ colorbar=None,
+ colorscale=None,
+ customdata=None,
+ customdatasrc=None,
+ featureidkey=None,
+ geojson=None,
+ hoverinfo=None,
+ hoverinfosrc=None,
+ hoverlabel=None,
+ hovertemplate=None,
+ hovertemplatesrc=None,
+ hovertext=None,
+ hovertextsrc=None,
+ ids=None,
+ idssrc=None,
+ legend=None,
+ legendgroup=None,
+ legendgrouptitle=None,
+ legendrank=None,
+ legendwidth=None,
+ locations=None,
+ locationssrc=None,
+ marker=None,
+ meta=None,
+ metasrc=None,
+ name=None,
+ reversescale=None,
+ selected=None,
+ selectedpoints=None,
+ showlegend=None,
+ showscale=None,
+ stream=None,
+ subplot=None,
+ text=None,
+ textsrc=None,
+ uid=None,
+ uirevision=None,
+ unselected=None,
+ visible=None,
+ z=None,
+ zauto=None,
+ zmax=None,
+ zmid=None,
+ zmin=None,
+ zsrc=None,
+ **kwargs,
+ ):
+ """
+ Construct a new Choroplethmap object
+
+ GeoJSON features to be filled are set in `geojson` The data
+ that describes the choropleth value-to-color mapping is set in
+ `locations` and `z`.
+
+ Parameters
+ ----------
+ arg
+ dict of properties compatible with this constructor or
+ an instance of :class:`plotly.graph_objs.Choroplethmap`
+ autocolorscale
+ Determines whether the colorscale is a default palette
+ (`autocolorscale: true`) or the palette determined by
+ `colorscale`. In case `colorscale` is unspecified or
+ `autocolorscale` is true, the default palette will be
+ chosen according to whether numbers in the `color`
+ array are all positive, all negative or mixed.
+ below
+ Determines if the choropleth polygons will be inserted
+ before the layer with the specified ID. By default,
+ choroplethmap traces are placed above the water layers.
+ If set to '', the layer will be inserted above every
+ existing layer.
+ coloraxis
+ Sets a reference to a shared color axis. References to
+ these shared color axes are "coloraxis", "coloraxis2",
+ "coloraxis3", etc. Settings for these shared color axes
+ are set in the layout, under `layout.coloraxis`,
+ `layout.coloraxis2`, etc. Note that multiple color
+ scales can be linked to the same color axis.
+ colorbar
+ :class:`plotly.graph_objects.choroplethmap.ColorBar`
+ instance or dict with compatible properties
+ colorscale
+ Sets the colorscale. The colorscale must be an array
+ containing arrays mapping a normalized value to an rgb,
+ rgba, hex, hsl, hsv, or named color string. At minimum,
+ a mapping for the lowest (0) and highest (1) values are
+ required. For example, `[[0, 'rgb(0,0,255)'], [1,
+ 'rgb(255,0,0)']]`. To control the bounds of the
+ colorscale in color space, use `zmin` and `zmax`.
+ Alternatively, `colorscale` may be a palette name
+ string of the following list: Blackbody,Bluered,Blues,C
+ ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
+ and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
+ customdata
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note
+ that, "scatter" traces also appends customdata items in
+ the markers DOM elements
+ customdatasrc
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+ featureidkey
+ Sets the key in GeoJSON features which is used as id to
+ match the items included in the `locations` array.
+ Support nested property, for example "properties.name".
+ geojson
+ Sets the GeoJSON data associated with this trace. It
+ can be set as a valid GeoJSON object or as a URL
+ string. Note that we only accept GeoJSONs of type
+ "FeatureCollection" or "Feature" with geometries of
+ type "Polygon" or "MultiPolygon".
+ hoverinfo
+ Determines which trace information appear on hover. If
+ `none` or `skip` are set, no information is displayed
+ upon hovering. But, if `none` is set, click and hover
+ events are still fired.
+ hoverinfosrc
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+ hoverlabel
+ :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
+ instance or dict with compatible properties
+ hovertemplate
+ Template string used for rendering the information that
+ appear on hover box. Note that this will override
+ `hoverinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}" as well as %{xother}, {%_xother},
+ {%_xother_}, {%xother_}. When showing info for several
+ points, "xother" will be added to those with different
+ x positions from the first point. An underscore before
+ or after "(x|y)other" will add a space on that side,
+ only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for
+ example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. The variables available in
+ `hovertemplate` are the ones emitted as event data
+ described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-
+ data. Additionally, every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Finally, the template string has access
+ to variable `properties` Anything contained in tag
+ `` is displayed in the secondary box, for
+ example "{fullData.name}". To hide the
+ secondary box completely, use an empty tag
+ ``.
+ hovertemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+ hovertext
+ Same as `text`.
+ hovertextsrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
+ ids
+ Assigns id labels to each datum. These ids for object
+ constancy of data points during animation. Should be an
+ array of strings, not numbers or any other type.
+ idssrc
+ Sets the source reference on Chart Studio Cloud for
+ `ids`.
+ legend
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2",
+ "legend3", etc. Settings for these legends are set in
+ the layout, under `layout.legend`, `layout.legend2`,
+ etc.
+ legendgroup
+ Sets the legend group for this trace. Traces and shapes
+ part of the same legend group hide/show at the same
+ time when toggling legend items.
+ legendgrouptitle
+ :class:`plotly.graph_objects.choroplethmap.Legendgroupt
+ itle` instance or dict with compatible properties
+ legendrank
+ Sets the legend rank for this trace. Items and groups
+ with smaller ranks are presented on top/left side while
+ with "reversed" `legend.traceorder` they are on
+ bottom/right side. The default legendrank is 1000, so
+ that you can use ranks less than 1000 to place certain
+ items before all unranked items, and ranks greater than
+ 1000 to go after all unranked items. When having
+ unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and
+ layout.
+ legendwidth
+ Sets the width (in px or fraction) of the legend for
+ this trace.
+ locations
+ Sets which features found in "geojson" to plot using
+ their feature `id` field.
+ locationssrc
+ Sets the source reference on Chart Studio Cloud for
+ `locations`.
+ marker
+ :class:`plotly.graph_objects.choroplethmap.Marker`
+ instance or dict with compatible properties
+ meta
+ Assigns extra meta information associated with this
+ trace that can be used in various text attributes.
+ Attributes such as trace `name`, graph, axis and
+ colorbar `title.text`, annotation `text`
+ `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta`
+ values in an attribute in the same trace, simply use
+ `%{meta[i]}` where `i` is the index or key of the
+ `meta` item in question. To access trace `meta` in
+ layout attributes, use `%{data[n[.meta[i]}` where `i`
+ is the index or key of the `meta` and `n` is the trace
+ index.
+ metasrc
+ Sets the source reference on Chart Studio Cloud for
+ `meta`.
+ name
+ Sets the trace name. The trace name appears as the
+ legend item and on hover.
+ reversescale
+ Reverses the color mapping if true. If true, `zmin`
+ will correspond to the last color in the array and
+ `zmax` will correspond to the first color.
+ selected
+ :class:`plotly.graph_objects.choroplethmap.Selected`
+ instance or dict with compatible properties
+ selectedpoints
+ Array containing integer indices of selected points.
+ Has an effect only for traces that support selections.
+ Note that an empty array means an empty selection where
+ the `unselected` are turned on for all points, whereas,
+ any other non-array values means no selection all where
+ the `selected` and `unselected` styles have no effect.
+ showlegend
+ Determines whether or not an item corresponding to this
+ trace is shown in the legend.
+ showscale
+ Determines whether or not a colorbar is displayed for
+ this trace.
+ stream
+ :class:`plotly.graph_objects.choroplethmap.Stream`
+ instance or dict with compatible properties
+ subplot
+ Sets a reference between this trace's data coordinates
+ and a map subplot. If "map" (the default value), the
+ data refer to `layout.map`. If "map2", the data refer
+ to `layout.map2`, and so on.
+ text
+ Sets the text elements associated with each location.
+ textsrc
+ Sets the source reference on Chart Studio Cloud for
+ `text`.
+ uid
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and
+ transitions.
+ uirevision
+ Controls persistence of some user-driven changes to the
+ trace: `constraintrange` in `parcoords` traces, as well
+ as some `editable: true` modifications such as `name`
+ and `colorbar.title`. Defaults to `layout.uirevision`.
+ Note that other user-driven trace attribute changes are
+ controlled by `layout` attributes: `trace.visible` is
+ controlled by `layout.legend.uirevision`,
+ `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)`
+ (accessible with `config: {editable: true}`) is
+ controlled by `layout.editrevision`. Trace changes are
+ tracked by `uid`, which only falls back on trace index
+ if no `uid` is provided. So if your app can add/remove
+ traces before the end of the `data` array, such that
+ the same trace has a different index, you can still
+ preserve user-driven changes if you give each trace a
+ `uid` that stays with it as it moves.
+ unselected
+ :class:`plotly.graph_objects.choroplethmap.Unselected`
+ instance or dict with compatible properties
+ visible
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as
+ a legend item (provided that the legend itself is
+ visible).
+ z
+ Sets the color values.
+ zauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here in `z`) or the
+ bounds set in `zmin` and `zmax` Defaults to `false`
+ when `zmin` and `zmax` are set by the user.
+ zmax
+ Sets the upper bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmin` must
+ be set as well.
+ zmid
+ Sets the mid-point of the color domain by scaling
+ `zmin` and/or `zmax` to be equidistant to this point.
+ Value should have the same units as in `z`. Has no
+ effect when `zauto` is `false`.
+ zmin
+ Sets the lower bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmax` must
+ be set as well.
+ zsrc
+ Sets the source reference on Chart Studio Cloud for
+ `z`.
+
+ Returns
+ -------
+ Choroplethmap
+ """
+ super(Choroplethmap, self).__init__("choroplethmap")
+
+ if "_parent" in kwargs:
+ self._parent = kwargs["_parent"]
+ return
+
+ # Validate arg
+ # ------------
+ if arg is None:
+ arg = {}
+ elif isinstance(arg, self.__class__):
+ arg = arg.to_plotly_json()
+ elif isinstance(arg, dict):
+ arg = _copy.copy(arg)
+ else:
+ raise ValueError(
+ """\
+The first argument to the plotly.graph_objs.Choroplethmap
+constructor must be a dict or
+an instance of :class:`plotly.graph_objs.Choroplethmap`"""
+ )
+
+ # Handle skip_invalid
+ # -------------------
+ self._skip_invalid = kwargs.pop("skip_invalid", False)
+ self._validate = kwargs.pop("_validate", True)
+
+ # Populate data dict with properties
+ # ----------------------------------
+ _v = arg.pop("autocolorscale", None)
+ _v = autocolorscale if autocolorscale is not None else _v
+ if _v is not None:
+ self["autocolorscale"] = _v
+ _v = arg.pop("below", None)
+ _v = below if below is not None else _v
+ if _v is not None:
+ self["below"] = _v
+ _v = arg.pop("coloraxis", None)
+ _v = coloraxis if coloraxis is not None else _v
+ if _v is not None:
+ self["coloraxis"] = _v
+ _v = arg.pop("colorbar", None)
+ _v = colorbar if colorbar is not None else _v
+ if _v is not None:
+ self["colorbar"] = _v
+ _v = arg.pop("colorscale", None)
+ _v = colorscale if colorscale is not None else _v
+ if _v is not None:
+ self["colorscale"] = _v
+ _v = arg.pop("customdata", None)
+ _v = customdata if customdata is not None else _v
+ if _v is not None:
+ self["customdata"] = _v
+ _v = arg.pop("customdatasrc", None)
+ _v = customdatasrc if customdatasrc is not None else _v
+ if _v is not None:
+ self["customdatasrc"] = _v
+ _v = arg.pop("featureidkey", None)
+ _v = featureidkey if featureidkey is not None else _v
+ if _v is not None:
+ self["featureidkey"] = _v
+ _v = arg.pop("geojson", None)
+ _v = geojson if geojson is not None else _v
+ if _v is not None:
+ self["geojson"] = _v
+ _v = arg.pop("hoverinfo", None)
+ _v = hoverinfo if hoverinfo is not None else _v
+ if _v is not None:
+ self["hoverinfo"] = _v
+ _v = arg.pop("hoverinfosrc", None)
+ _v = hoverinfosrc if hoverinfosrc is not None else _v
+ if _v is not None:
+ self["hoverinfosrc"] = _v
+ _v = arg.pop("hoverlabel", None)
+ _v = hoverlabel if hoverlabel is not None else _v
+ if _v is not None:
+ self["hoverlabel"] = _v
+ _v = arg.pop("hovertemplate", None)
+ _v = hovertemplate if hovertemplate is not None else _v
+ if _v is not None:
+ self["hovertemplate"] = _v
+ _v = arg.pop("hovertemplatesrc", None)
+ _v = hovertemplatesrc if hovertemplatesrc is not None else _v
+ if _v is not None:
+ self["hovertemplatesrc"] = _v
+ _v = arg.pop("hovertext", None)
+ _v = hovertext if hovertext is not None else _v
+ if _v is not None:
+ self["hovertext"] = _v
+ _v = arg.pop("hovertextsrc", None)
+ _v = hovertextsrc if hovertextsrc is not None else _v
+ if _v is not None:
+ self["hovertextsrc"] = _v
+ _v = arg.pop("ids", None)
+ _v = ids if ids is not None else _v
+ if _v is not None:
+ self["ids"] = _v
+ _v = arg.pop("idssrc", None)
+ _v = idssrc if idssrc is not None else _v
+ if _v is not None:
+ self["idssrc"] = _v
+ _v = arg.pop("legend", None)
+ _v = legend if legend is not None else _v
+ if _v is not None:
+ self["legend"] = _v
+ _v = arg.pop("legendgroup", None)
+ _v = legendgroup if legendgroup is not None else _v
+ if _v is not None:
+ self["legendgroup"] = _v
+ _v = arg.pop("legendgrouptitle", None)
+ _v = legendgrouptitle if legendgrouptitle is not None else _v
+ if _v is not None:
+ self["legendgrouptitle"] = _v
+ _v = arg.pop("legendrank", None)
+ _v = legendrank if legendrank is not None else _v
+ if _v is not None:
+ self["legendrank"] = _v
+ _v = arg.pop("legendwidth", None)
+ _v = legendwidth if legendwidth is not None else _v
+ if _v is not None:
+ self["legendwidth"] = _v
+ _v = arg.pop("locations", None)
+ _v = locations if locations is not None else _v
+ if _v is not None:
+ self["locations"] = _v
+ _v = arg.pop("locationssrc", None)
+ _v = locationssrc if locationssrc is not None else _v
+ if _v is not None:
+ self["locationssrc"] = _v
+ _v = arg.pop("marker", None)
+ _v = marker if marker is not None else _v
+ if _v is not None:
+ self["marker"] = _v
+ _v = arg.pop("meta", None)
+ _v = meta if meta is not None else _v
+ if _v is not None:
+ self["meta"] = _v
+ _v = arg.pop("metasrc", None)
+ _v = metasrc if metasrc is not None else _v
+ if _v is not None:
+ self["metasrc"] = _v
+ _v = arg.pop("name", None)
+ _v = name if name is not None else _v
+ if _v is not None:
+ self["name"] = _v
+ _v = arg.pop("reversescale", None)
+ _v = reversescale if reversescale is not None else _v
+ if _v is not None:
+ self["reversescale"] = _v
+ _v = arg.pop("selected", None)
+ _v = selected if selected is not None else _v
+ if _v is not None:
+ self["selected"] = _v
+ _v = arg.pop("selectedpoints", None)
+ _v = selectedpoints if selectedpoints is not None else _v
+ if _v is not None:
+ self["selectedpoints"] = _v
+ _v = arg.pop("showlegend", None)
+ _v = showlegend if showlegend is not None else _v
+ if _v is not None:
+ self["showlegend"] = _v
+ _v = arg.pop("showscale", None)
+ _v = showscale if showscale is not None else _v
+ if _v is not None:
+ self["showscale"] = _v
+ _v = arg.pop("stream", None)
+ _v = stream if stream is not None else _v
+ if _v is not None:
+ self["stream"] = _v
+ _v = arg.pop("subplot", None)
+ _v = subplot if subplot is not None else _v
+ if _v is not None:
+ self["subplot"] = _v
+ _v = arg.pop("text", None)
+ _v = text if text is not None else _v
+ if _v is not None:
+ self["text"] = _v
+ _v = arg.pop("textsrc", None)
+ _v = textsrc if textsrc is not None else _v
+ if _v is not None:
+ self["textsrc"] = _v
+ _v = arg.pop("uid", None)
+ _v = uid if uid is not None else _v
+ if _v is not None:
+ self["uid"] = _v
+ _v = arg.pop("uirevision", None)
+ _v = uirevision if uirevision is not None else _v
+ if _v is not None:
+ self["uirevision"] = _v
+ _v = arg.pop("unselected", None)
+ _v = unselected if unselected is not None else _v
+ if _v is not None:
+ self["unselected"] = _v
+ _v = arg.pop("visible", None)
+ _v = visible if visible is not None else _v
+ if _v is not None:
+ self["visible"] = _v
+ _v = arg.pop("z", None)
+ _v = z if z is not None else _v
+ if _v is not None:
+ self["z"] = _v
+ _v = arg.pop("zauto", None)
+ _v = zauto if zauto is not None else _v
+ if _v is not None:
+ self["zauto"] = _v
+ _v = arg.pop("zmax", None)
+ _v = zmax if zmax is not None else _v
+ if _v is not None:
+ self["zmax"] = _v
+ _v = arg.pop("zmid", None)
+ _v = zmid if zmid is not None else _v
+ if _v is not None:
+ self["zmid"] = _v
+ _v = arg.pop("zmin", None)
+ _v = zmin if zmin is not None else _v
+ if _v is not None:
+ self["zmin"] = _v
+ _v = arg.pop("zsrc", None)
+ _v = zsrc if zsrc is not None else _v
+ if _v is not None:
+ self["zsrc"] = _v
+
+ # Read-only literals
+ # ------------------
+
+ self._props["type"] = "choroplethmap"
+ arg.pop("type", None)
+
+ # Process unknown kwargs
+ # ----------------------
+ self._process_kwargs(**dict(arg, **kwargs))
+
+ # Reset skip_invalid
+ # ------------------
+ self._skip_invalid = False
diff --git a/packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py b/packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py
index c532fa0cf69..06595081769 100644
--- a/packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py
+++ b/packages/python/plotly/plotly/graph_objs/_choroplethmapbox.py
@@ -1261,9 +1261,12 @@ def stream(self, val):
@property
def subplot(self):
"""
- Sets a reference between this trace's data coordinates and a
- mapbox subplot. If "mapbox" (the default value), the data refer
- to `layout.mapbox`. If "mapbox2", the data refer to
+ mapbox subplots and traces are deprecated! Please consider
+ switching to `map` subplots and traces. Learn more at:
+ https://plotly.com/javascript/maplibre-migration/ Sets a
+ reference between this trace's data coordinates and a mapbox
+ subplot. If "mapbox" (the default value), the data refer to
+ `layout.mapbox`. If "mapbox2", the data refer to
`layout.mapbox2`, and so on.
The 'subplot' property is an identifier of a particular
@@ -1755,10 +1758,14 @@ def _prop_descriptions(self):
: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),
- the data refer to `layout.mapbox`. If "mapbox2", the
- data refer to `layout.mapbox2`, and so on.
+ mapbox subplots and traces are deprecated! Please
+ consider switching to `map` subplots and traces. Learn
+ more at: https://plotly.com/javascript/maplibre-
+ migration/ Sets a reference between this trace's data
+ coordinates and a mapbox subplot. If "mapbox" (the
+ default value), the data refer to `layout.mapbox`. If
+ "mapbox2", the data refer to `layout.mapbox2`, and so
+ on.
text
Sets the text elements associated with each location.
textsrc
@@ -1875,9 +1882,12 @@ def __init__(
"""
Construct a new Choroplethmapbox object
- GeoJSON features to be filled are set in `geojson` The data
- that describes the choropleth value-to-color mapping is set in
- `locations` and `z`.
+ "choroplethmapbox" trace is deprecated! Please consider
+ switching to the "choroplethmap" trace type and `map` subplots.
+ Learn more at: https://plotly.com/javascript/maplibre-
+ migration/ GeoJSON features to be filled are set in `geojson`
+ The data that describes the choropleth value-to-color mapping
+ is set in `locations` and `z`.
Parameters
----------
@@ -2073,10 +2083,14 @@ def __init__(
: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),
- the data refer to `layout.mapbox`. If "mapbox2", the
- data refer to `layout.mapbox2`, and so on.
+ mapbox subplots and traces are deprecated! Please
+ consider switching to `map` subplots and traces. Learn
+ more at: https://plotly.com/javascript/maplibre-
+ migration/ Sets a reference between this trace's data
+ coordinates and a mapbox subplot. If "mapbox" (the
+ default value), the data refer to `layout.mapbox`. If
+ "mapbox2", the data refer to `layout.mapbox2`, and so
+ on.
text
Sets the text elements associated with each location.
textsrc
diff --git a/packages/python/plotly/plotly/graph_objs/_densitymap.py b/packages/python/plotly/plotly/graph_objs/_densitymap.py
new file mode 100644
index 00000000000..615b65e636a
--- /dev/null
+++ b/packages/python/plotly/plotly/graph_objs/_densitymap.py
@@ -0,0 +1,2317 @@
+from plotly.basedatatypes import BaseTraceType as _BaseTraceType
+import copy as _copy
+
+
+class Densitymap(_BaseTraceType):
+
+ # class properties
+ # --------------------
+ _parent_path_str = ""
+ _path_str = "densitymap"
+ _valid_props = {
+ "autocolorscale",
+ "below",
+ "coloraxis",
+ "colorbar",
+ "colorscale",
+ "customdata",
+ "customdatasrc",
+ "hoverinfo",
+ "hoverinfosrc",
+ "hoverlabel",
+ "hovertemplate",
+ "hovertemplatesrc",
+ "hovertext",
+ "hovertextsrc",
+ "ids",
+ "idssrc",
+ "lat",
+ "latsrc",
+ "legend",
+ "legendgroup",
+ "legendgrouptitle",
+ "legendrank",
+ "legendwidth",
+ "lon",
+ "lonsrc",
+ "meta",
+ "metasrc",
+ "name",
+ "opacity",
+ "radius",
+ "radiussrc",
+ "reversescale",
+ "showlegend",
+ "showscale",
+ "stream",
+ "subplot",
+ "text",
+ "textsrc",
+ "type",
+ "uid",
+ "uirevision",
+ "visible",
+ "z",
+ "zauto",
+ "zmax",
+ "zmid",
+ "zmin",
+ "zsrc",
+ }
+
+ # autocolorscale
+ # --------------
+ @property
+ def autocolorscale(self):
+ """
+ Determines whether the colorscale is a default palette
+ (`autocolorscale: true`) or the palette determined by
+ `colorscale`. In case `colorscale` is unspecified or
+ `autocolorscale` is true, the default palette will be chosen
+ according to whether numbers in the `color` array are all
+ positive, all negative or mixed.
+
+ The 'autocolorscale' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["autocolorscale"]
+
+ @autocolorscale.setter
+ def autocolorscale(self, val):
+ self["autocolorscale"] = val
+
+ # below
+ # -----
+ @property
+ def below(self):
+ """
+ Determines if the densitymap trace will be inserted before the
+ layer with the specified ID. By default, densitymap traces are
+ placed below the first layer of type symbol If set to '', the
+ layer will be inserted above every existing layer.
+
+ The 'below' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["below"]
+
+ @below.setter
+ def below(self, val):
+ self["below"] = val
+
+ # coloraxis
+ # ---------
+ @property
+ def coloraxis(self):
+ """
+ Sets a reference to a shared color axis. References to these
+ shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
+ etc. Settings for these shared color axes are set in the
+ layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
+ Note that multiple color scales can be linked to the same color
+ axis.
+
+ The 'coloraxis' property is an identifier of a particular
+ subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
+ optionally followed by an integer >= 1
+ (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
+
+ Returns
+ -------
+ str
+ """
+ return self["coloraxis"]
+
+ @coloraxis.setter
+ def coloraxis(self, val):
+ self["coloraxis"] = val
+
+ # colorbar
+ # --------
+ @property
+ def colorbar(self):
+ """
+ The 'colorbar' property is an instance of ColorBar
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.densitymap.ColorBar`
+ - A dict of string/value properties that will be passed
+ to the ColorBar constructor
+
+ Supported dict properties:
+
+ bgcolor
+ Sets the color of padded area.
+ bordercolor
+ Sets the axis line color.
+ borderwidth
+ Sets the width (in px) or the border enclosing
+ this color bar.
+ dtick
+ Sets the step in-between ticks on this axis.
+ Use with `tick0`. Must be a positive number, or
+ special strings available to "log" and "date"
+ axes. If the axis `type` is "log", then ticks
+ are set every 10^(n*dtick) where n is the tick
+ number. For example, to set a tick mark at 1,
+ 10, 100, 1000, ... set dtick to 1. To set tick
+ marks at 1, 100, 10000, ... set dtick to 2. To
+ set tick marks at 1, 5, 25, 125, 625, 3125, ...
+ set dtick to log_10(5), or 0.69897000433. "log"
+ has several special values; "L", where `f`
+ is a positive number, gives ticks linearly
+ spaced in value (but not position). For example
+ `tick0` = 0.1, `dtick` = "L0.5" will put ticks
+ at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
+ plus small digits between, use "D1" (all
+ digits) or "D2" (only 2 and 5). `tick0` is
+ ignored for "D1" and "D2". If the axis `type`
+ is "date", then you must convert the time to
+ milliseconds. For example, to set the interval
+ between ticks to one day, set `dtick` to
+ 86400000.0. "date" also has special values
+ "M" gives ticks spaced by a number of
+ months. `n` must be a positive integer. To set
+ ticks on the 15th of every third month, set
+ `tick0` to "2000-01-15" and `dtick` to "M3". To
+ set ticks every 4 years, set `dtick` to "M48"
+ exponentformat
+ Determines a formatting rule for the tick
+ exponents. For example, consider the number
+ 1,000,000,000. If "none", it appears as
+ 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
+ "power", 1x10^9 (with 9 in a super script). If
+ "SI", 1G. If "B", 1B.
+ labelalias
+ Replacement text for specific tick or hover
+ labels. For example using {US: 'USA', CA:
+ 'Canada'} changes US to USA and CA to Canada.
+ The labels we would have shown must match the
+ keys exactly, after adding any tickprefix or
+ ticksuffix. For negative numbers the minus sign
+ symbol used (U+2212) is wider than the regular
+ ascii dash. That means you need to use −1
+ instead of -1. labelalias can be used with any
+ axis type, and both keys (if needed) and values
+ (if desired) can include html-like tags or
+ MathJax.
+ len
+ Sets the length of the color bar This measure
+ excludes the padding of both ends. That is, the
+ color bar length is this length minus the
+ padding on both ends.
+ lenmode
+ Determines whether this color bar's length
+ (i.e. the measure in the color variation
+ direction) is set in units of plot "fraction"
+ or in *pixels. Use `len` to set the value.
+ minexponent
+ Hide SI prefix for 10^n if |n| is below this
+ number. This only has an effect when
+ `tickformat` is "SI" or "B".
+ nticks
+ Specifies the maximum number of ticks for the
+ particular axis. The actual number of ticks
+ will be chosen automatically to be less than or
+ equal to `nticks`. Has an effect only if
+ `tickmode` is set to "auto".
+ orientation
+ Sets the orientation of the colorbar.
+ outlinecolor
+ Sets the axis line color.
+ outlinewidth
+ Sets the width (in px) of the axis line.
+ separatethousands
+ If "true", even 4-digit integers are separated
+ showexponent
+ If "all", all exponents are shown besides their
+ significands. If "first", only the exponent of
+ the first tick is shown. If "last", only the
+ exponent of the last tick is shown. If "none",
+ no exponents appear.
+ showticklabels
+ Determines whether or not the tick labels are
+ drawn.
+ showtickprefix
+ If "all", all tick labels are displayed with a
+ prefix. If "first", only the first tick is
+ displayed with a prefix. If "last", only the
+ last tick is displayed with a suffix. If
+ "none", tick prefixes are hidden.
+ showticksuffix
+ Same as `showtickprefix` but for tick suffixes.
+ thickness
+ Sets the thickness of the color bar This
+ measure excludes the size of the padding, ticks
+ and labels.
+ thicknessmode
+ Determines whether this color bar's thickness
+ (i.e. the measure in the constant color
+ direction) is set in units of plot "fraction"
+ or in "pixels". Use `thickness` to set the
+ value.
+ tick0
+ Sets the placement of the first tick on this
+ axis. Use with `dtick`. If the axis `type` is
+ "log", then you must take the log of your
+ starting tick (e.g. to set the starting tick to
+ 100, set the `tick0` to 2) except when
+ `dtick`=*L* (see `dtick` for more info). If
+ the axis `type` is "date", it should be a date
+ string, like date data. If the axis `type` is
+ "category", it should be a number, using the
+ scale where each category is assigned a serial
+ number from zero in the order it appears.
+ tickangle
+ Sets the angle of the tick labels with respect
+ to the horizontal. For example, a `tickangle`
+ of -90 draws the tick labels vertically.
+ tickcolor
+ Sets the tick color.
+ tickfont
+ Sets the color bar's tick label font
+ tickformat
+ Sets the tick label formatting rule using d3
+ formatting mini-languages which are very
+ similar to those in Python. For numbers, see: h
+ ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
+ format. And for dates see:
+ https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format. We add two
+ items to d3's date formatter: "%h" for half of
+ the year as a decimal number as well as "%{n}f"
+ for fractional seconds with n digits. For
+ example, *2016-10-13 09:15:23.456* with
+ tickformat "%H~%M~%S.%2f" would display
+ "09~15~23.46"
+ tickformatstops
+ A tuple of :class:`plotly.graph_objects.density
+ map.colorbar.Tickformatstop` instances or dicts
+ with compatible properties
+ tickformatstopdefaults
+ When used in a template (as layout.template.dat
+ a.densitymap.colorbar.tickformatstopdefaults),
+ sets the default property values to use for
+ elements of densitymap.colorbar.tickformatstops
+ ticklabeloverflow
+ Determines how we handle tick labels that would
+ overflow either the graph div or the domain of
+ the axis. The default value for inside tick
+ labels is *hide past domain*. In other cases
+ the default is *hide past div*.
+ ticklabelposition
+ Determines where tick labels are drawn relative
+ to the ticks. Left and right options are used
+ when `orientation` is "h", top and bottom when
+ `orientation` is "v".
+ ticklabelstep
+ Sets the spacing between tick labels as
+ compared to the spacing between ticks. A value
+ of 1 (default) means each tick gets a label. A
+ value of 2 means shows every 2nd label. A
+ larger value n means only every nth tick is
+ labeled. `tick0` determines which labels are
+ shown. Not implemented for axes with `type`
+ "log" or "multicategory", or when `tickmode` is
+ "array".
+ ticklen
+ Sets the tick length (in px).
+ tickmode
+ Sets the tick mode for this axis. If "auto",
+ the number of ticks is set via `nticks`. If
+ "linear", the placement of the ticks is
+ determined by a starting position `tick0` and a
+ tick step `dtick` ("linear" is the default
+ value if `tick0` and `dtick` are provided). If
+ "array", the placement of the ticks is set via
+ `tickvals` and the tick text is `ticktext`.
+ ("array" is the default value if `tickvals` is
+ provided).
+ tickprefix
+ Sets a tick label prefix.
+ ticks
+ Determines whether ticks are drawn or not. If
+ "", this axis' ticks are not drawn. If
+ "outside" ("inside"), this axis' are drawn
+ outside (inside) the axis lines.
+ ticksuffix
+ Sets a tick label suffix.
+ ticktext
+ Sets the text displayed at the ticks position
+ via `tickvals`. Only has an effect if
+ `tickmode` is set to "array". Used with
+ `tickvals`.
+ ticktextsrc
+ Sets the source reference on Chart Studio Cloud
+ for `ticktext`.
+ tickvals
+ Sets the values at which ticks on this axis
+ appear. Only has an effect if `tickmode` is set
+ to "array". Used with `ticktext`.
+ tickvalssrc
+ Sets the source reference on Chart Studio Cloud
+ for `tickvals`.
+ tickwidth
+ Sets the tick width (in px).
+ title
+ :class:`plotly.graph_objects.densitymap.colorba
+ r.Title` instance or dict with compatible
+ properties
+ titlefont
+ Deprecated: Please use
+ densitymap.colorbar.title.font instead. Sets
+ this color bar's title font. Note that the
+ title's font used to be set by the now
+ deprecated `titlefont` attribute.
+ titleside
+ Deprecated: Please use
+ densitymap.colorbar.title.side instead.
+ Determines the location of color bar's title
+ with respect to the color bar. Defaults to
+ "top" when `orientation` if "v" and defaults
+ to "right" when `orientation` if "h". Note that
+ the title's location used to be set by the now
+ deprecated `titleside` attribute.
+ x
+ Sets the x position with respect to `xref` of
+ the color bar (in plot fraction). When `xref`
+ is "paper", defaults to 1.02 when `orientation`
+ is "v" and 0.5 when `orientation` is "h". When
+ `xref` is "container", defaults to 1 when
+ `orientation` is "v" and 0.5 when `orientation`
+ is "h". Must be between 0 and 1 if `xref` is
+ "container" and between "-2" and 3 if `xref` is
+ "paper".
+ xanchor
+ Sets this color bar's horizontal position
+ anchor. This anchor binds the `x` position to
+ the "left", "center" or "right" of the color
+ bar. Defaults to "left" when `orientation` is
+ "v" and "center" when `orientation` is "h".
+ xpad
+ Sets the amount of padding (in px) along the x
+ direction.
+ xref
+ Sets the container `x` refers to. "container"
+ spans the entire `width` of the plot. "paper"
+ refers to the width of the plotting area only.
+ y
+ Sets the y position with respect to `yref` of
+ the color bar (in plot fraction). When `yref`
+ is "paper", defaults to 0.5 when `orientation`
+ is "v" and 1.02 when `orientation` is "h". When
+ `yref` is "container", defaults to 0.5 when
+ `orientation` is "v" and 1 when `orientation`
+ is "h". Must be between 0 and 1 if `yref` is
+ "container" and between "-2" and 3 if `yref` is
+ "paper".
+ yanchor
+ Sets this color bar's vertical position anchor
+ This anchor binds the `y` position to the
+ "top", "middle" or "bottom" of the color bar.
+ Defaults to "middle" when `orientation` is "v"
+ and "bottom" when `orientation` is "h".
+ ypad
+ Sets the amount of padding (in px) along the y
+ direction.
+ yref
+ Sets the container `y` refers to. "container"
+ spans the entire `height` of the plot. "paper"
+ refers to the height of the plotting area only.
+
+ Returns
+ -------
+ plotly.graph_objs.densitymap.ColorBar
+ """
+ return self["colorbar"]
+
+ @colorbar.setter
+ def colorbar(self, val):
+ self["colorbar"] = val
+
+ # colorscale
+ # ----------
+ @property
+ def colorscale(self):
+ """
+ Sets the colorscale. The colorscale must be an array containing
+ arrays mapping a normalized value to an rgb, rgba, hex, hsl,
+ hsv, or named color string. At minimum, a mapping for the
+ lowest (0) and highest (1) values are required. For example,
+ `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the
+ bounds of the colorscale in color space, use `zmin` and `zmax`.
+ Alternatively, `colorscale` may be a palette name string of the
+ following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
+ Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
+ YlGnBu,YlOrRd.
+
+ The 'colorscale' property is a colorscale and may be
+ specified as:
+ - A list of colors that will be spaced evenly to create the colorscale.
+ Many predefined colorscale lists are included in the sequential, diverging,
+ and cyclical modules in the plotly.colors package.
+ - A list of 2-element lists where the first element is the
+ normalized color level value (starting at 0 and ending at 1),
+ and the second item is a valid color string.
+ (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
+ - One of the following named colorscales:
+ ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
+ 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
+ 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
+ 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
+ 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
+ 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
+ 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
+ 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
+ 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
+ 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
+ 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
+ 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
+ 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
+ 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
+ 'ylorrd'].
+ Appending '_r' to a named colorscale reverses it.
+
+ Returns
+ -------
+ str
+ """
+ return self["colorscale"]
+
+ @colorscale.setter
+ def colorscale(self, val):
+ self["colorscale"] = val
+
+ # customdata
+ # ----------
+ @property
+ def customdata(self):
+ """
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note that,
+ "scatter" traces also appends customdata items in the markers
+ DOM elements
+
+ The 'customdata' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["customdata"]
+
+ @customdata.setter
+ def customdata(self, val):
+ self["customdata"] = val
+
+ # customdatasrc
+ # -------------
+ @property
+ def customdatasrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+
+ The 'customdatasrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["customdatasrc"]
+
+ @customdatasrc.setter
+ def customdatasrc(self, val):
+ self["customdatasrc"] = val
+
+ # hoverinfo
+ # ---------
+ @property
+ def hoverinfo(self):
+ """
+ Determines which trace information appear on hover. If `none`
+ or `skip` are set, no information is displayed upon hovering.
+ But, if `none` is set, click and hover events are still fired.
+
+ The 'hoverinfo' property is a flaglist and may be specified
+ as a string containing:
+ - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters
+ (e.g. 'lon+lat')
+ OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
+ - A list or array of the above
+
+ Returns
+ -------
+ Any|numpy.ndarray
+ """
+ return self["hoverinfo"]
+
+ @hoverinfo.setter
+ def hoverinfo(self, val):
+ self["hoverinfo"] = val
+
+ # hoverinfosrc
+ # ------------
+ @property
+ def hoverinfosrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+
+ The 'hoverinfosrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["hoverinfosrc"]
+
+ @hoverinfosrc.setter
+ def hoverinfosrc(self, val):
+ self["hoverinfosrc"] = val
+
+ # hoverlabel
+ # ----------
+ @property
+ def hoverlabel(self):
+ """
+ The 'hoverlabel' property is an instance of Hoverlabel
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.densitymap.Hoverlabel`
+ - A dict of string/value properties that will be passed
+ to the Hoverlabel constructor
+
+ Supported dict properties:
+
+ align
+ Sets the horizontal alignment of the text
+ content within hover label box. Has an effect
+ only if the hover label text spans more two or
+ more lines
+ alignsrc
+ Sets the source reference on Chart Studio Cloud
+ for `align`.
+ bgcolor
+ Sets the background color of the hover labels
+ for this trace
+ bgcolorsrc
+ Sets the source reference on Chart Studio Cloud
+ for `bgcolor`.
+ bordercolor
+ Sets the border color of the hover labels for
+ this trace.
+ bordercolorsrc
+ Sets the source reference on Chart Studio Cloud
+ for `bordercolor`.
+ font
+ Sets the font used in hover labels.
+ namelength
+ Sets the default length (in number of
+ characters) of the trace name in the hover
+ labels for all traces. -1 shows the whole name
+ regardless of length. 0-3 shows the first 0-3
+ characters, and an integer >3 will show the
+ whole name if it is less than that many
+ characters, but if it is longer, will truncate
+ to `namelength - 3` characters and add an
+ ellipsis.
+ namelengthsrc
+ Sets the source reference on Chart Studio Cloud
+ for `namelength`.
+
+ Returns
+ -------
+ plotly.graph_objs.densitymap.Hoverlabel
+ """
+ return self["hoverlabel"]
+
+ @hoverlabel.setter
+ def hoverlabel(self, val):
+ self["hoverlabel"] = val
+
+ # hovertemplate
+ # -------------
+ @property
+ def hovertemplate(self):
+ """
+ Template string used for rendering the information that appear
+ on hover box. Note that this will override `hoverinfo`.
+ Variables are inserted using %{variable}, for example "y: %{y}"
+ as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
+ showing info for several points, "xother" will be added to
+ those with different x positions from the first point. An
+ underscore before or after "(x|y)other" will add a space on
+ that side, only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for example
+ "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
+ details on the formatting syntax. Dates are formatted using
+ d3-time-format's syntax %{variable|d3-time-format}, for example
+ "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the date
+ formatting syntax. The variables available in `hovertemplate`
+ are the ones emitted as event data described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-data.
+ Additionally, every attributes that can be specified per-point
+ (the ones that are `arrayOk: true`) are available. Anything
+ contained in tag `` is displayed in the secondary box,
+ for example "{fullData.name}". To hide the
+ secondary box completely, use an empty tag ``.
+
+ The 'hovertemplate' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+ - A tuple, list, or one-dimensional numpy array of the above
+
+ Returns
+ -------
+ str|numpy.ndarray
+ """
+ return self["hovertemplate"]
+
+ @hovertemplate.setter
+ def hovertemplate(self, val):
+ self["hovertemplate"] = val
+
+ # hovertemplatesrc
+ # ----------------
+ @property
+ def hovertemplatesrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+
+ The 'hovertemplatesrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["hovertemplatesrc"]
+
+ @hovertemplatesrc.setter
+ def hovertemplatesrc(self, val):
+ self["hovertemplatesrc"] = val
+
+ # hovertext
+ # ---------
+ @property
+ def hovertext(self):
+ """
+ Sets hover text elements associated with each (lon,lat) pair If
+ a single string, the same string appears over all the data
+ points. If an array of string, the items are mapped in order to
+ the this trace's (lon,lat) coordinates. To be seen, trace
+ `hoverinfo` must contain a "text" flag.
+
+ The 'hovertext' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+ - A tuple, list, or one-dimensional numpy array of the above
+
+ Returns
+ -------
+ str|numpy.ndarray
+ """
+ return self["hovertext"]
+
+ @hovertext.setter
+ def hovertext(self, val):
+ self["hovertext"] = val
+
+ # hovertextsrc
+ # ------------
+ @property
+ def hovertextsrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
+
+ The 'hovertextsrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["hovertextsrc"]
+
+ @hovertextsrc.setter
+ def hovertextsrc(self, val):
+ self["hovertextsrc"] = val
+
+ # ids
+ # ---
+ @property
+ def ids(self):
+ """
+ Assigns id labels to each datum. These ids for object constancy
+ of data points during animation. Should be an array of strings,
+ not numbers or any other type.
+
+ The 'ids' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["ids"]
+
+ @ids.setter
+ def ids(self, val):
+ self["ids"] = val
+
+ # idssrc
+ # ------
+ @property
+ def idssrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `ids`.
+
+ The 'idssrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["idssrc"]
+
+ @idssrc.setter
+ def idssrc(self, val):
+ self["idssrc"] = val
+
+ # lat
+ # ---
+ @property
+ def lat(self):
+ """
+ Sets the latitude coordinates (in degrees North).
+
+ The 'lat' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["lat"]
+
+ @lat.setter
+ def lat(self, val):
+ self["lat"] = val
+
+ # latsrc
+ # ------
+ @property
+ def latsrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `lat`.
+
+ The 'latsrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["latsrc"]
+
+ @latsrc.setter
+ def latsrc(self, val):
+ self["latsrc"] = val
+
+ # legend
+ # ------
+ @property
+ def legend(self):
+ """
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2", "legend3",
+ etc. Settings for these legends are set in the layout, under
+ `layout.legend`, `layout.legend2`, etc.
+
+ The 'legend' property is an identifier of a particular
+ subplot, of type 'legend', that may be specified as the string 'legend'
+ optionally followed by an integer >= 1
+ (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
+
+ Returns
+ -------
+ str
+ """
+ return self["legend"]
+
+ @legend.setter
+ def legend(self, val):
+ self["legend"] = val
+
+ # legendgroup
+ # -----------
+ @property
+ def legendgroup(self):
+ """
+ Sets the legend group for this trace. Traces and shapes part of
+ the same legend group hide/show at the same time when toggling
+ legend items.
+
+ The 'legendgroup' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["legendgroup"]
+
+ @legendgroup.setter
+ def legendgroup(self, val):
+ self["legendgroup"] = val
+
+ # legendgrouptitle
+ # ----------------
+ @property
+ def legendgrouptitle(self):
+ """
+ The 'legendgrouptitle' property is an instance of Legendgrouptitle
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.densitymap.Legendgrouptitle`
+ - A dict of string/value properties that will be passed
+ to the Legendgrouptitle constructor
+
+ Supported dict properties:
+
+ font
+ Sets this legend group's title font.
+ text
+ Sets the title of the legend group.
+
+ Returns
+ -------
+ plotly.graph_objs.densitymap.Legendgrouptitle
+ """
+ return self["legendgrouptitle"]
+
+ @legendgrouptitle.setter
+ def legendgrouptitle(self, val):
+ self["legendgrouptitle"] = val
+
+ # legendrank
+ # ----------
+ @property
+ def legendrank(self):
+ """
+ Sets the legend rank for this trace. Items and groups with
+ smaller ranks are presented on top/left side while with
+ "reversed" `legend.traceorder` they are on bottom/right side.
+ The default legendrank is 1000, so that you can use ranks less
+ than 1000 to place certain items before all unranked items, and
+ ranks greater than 1000 to go after all unranked items. When
+ having unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and layout.
+
+ The 'legendrank' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ int|float
+ """
+ return self["legendrank"]
+
+ @legendrank.setter
+ def legendrank(self, val):
+ self["legendrank"] = val
+
+ # legendwidth
+ # -----------
+ @property
+ def legendwidth(self):
+ """
+ Sets the width (in px or fraction) of the legend for this
+ trace.
+
+ The 'legendwidth' property is a number and may be specified as:
+ - An int or float in the interval [0, inf]
+
+ Returns
+ -------
+ int|float
+ """
+ return self["legendwidth"]
+
+ @legendwidth.setter
+ def legendwidth(self, val):
+ self["legendwidth"] = val
+
+ # lon
+ # ---
+ @property
+ def lon(self):
+ """
+ Sets the longitude coordinates (in degrees East).
+
+ The 'lon' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["lon"]
+
+ @lon.setter
+ def lon(self, val):
+ self["lon"] = val
+
+ # lonsrc
+ # ------
+ @property
+ def lonsrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `lon`.
+
+ The 'lonsrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["lonsrc"]
+
+ @lonsrc.setter
+ def lonsrc(self, val):
+ self["lonsrc"] = val
+
+ # meta
+ # ----
+ @property
+ def meta(self):
+ """
+ Assigns extra meta information associated with this trace that
+ can be used in various text attributes. Attributes such as
+ trace `name`, graph, axis and colorbar `title.text`, annotation
+ `text` `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta` values in
+ an attribute in the same trace, simply use `%{meta[i]}` where
+ `i` is the index or key of the `meta` item in question. To
+ access trace `meta` in layout attributes, use
+ `%{data[n[.meta[i]}` where `i` is the index or key of the
+ `meta` and `n` is the trace index.
+
+ The 'meta' property accepts values of any type
+
+ Returns
+ -------
+ Any|numpy.ndarray
+ """
+ return self["meta"]
+
+ @meta.setter
+ def meta(self, val):
+ self["meta"] = val
+
+ # metasrc
+ # -------
+ @property
+ def metasrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `meta`.
+
+ The 'metasrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["metasrc"]
+
+ @metasrc.setter
+ def metasrc(self, val):
+ self["metasrc"] = val
+
+ # name
+ # ----
+ @property
+ def name(self):
+ """
+ Sets the trace name. The trace name appears as the legend item
+ and on hover.
+
+ The 'name' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["name"]
+
+ @name.setter
+ def name(self, val):
+ self["name"] = val
+
+ # opacity
+ # -------
+ @property
+ def opacity(self):
+ """
+ Sets the opacity of the trace.
+
+ The 'opacity' property is a number and may be specified as:
+ - An int or float in the interval [0, 1]
+
+ Returns
+ -------
+ int|float
+ """
+ return self["opacity"]
+
+ @opacity.setter
+ def opacity(self, val):
+ self["opacity"] = val
+
+ # radius
+ # ------
+ @property
+ def radius(self):
+ """
+ Sets the radius of influence of one `lon` / `lat` point in
+ pixels. Increasing the value makes the densitymap trace
+ smoother, but less detailed.
+
+ The 'radius' property is a number and may be specified as:
+ - An int or float in the interval [1, inf]
+ - A tuple, list, or one-dimensional numpy array of the above
+
+ Returns
+ -------
+ int|float|numpy.ndarray
+ """
+ return self["radius"]
+
+ @radius.setter
+ def radius(self, val):
+ self["radius"] = val
+
+ # radiussrc
+ # ---------
+ @property
+ def radiussrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `radius`.
+
+ The 'radiussrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["radiussrc"]
+
+ @radiussrc.setter
+ def radiussrc(self, val):
+ self["radiussrc"] = val
+
+ # reversescale
+ # ------------
+ @property
+ def reversescale(self):
+ """
+ Reverses the color mapping if true. If true, `zmin` will
+ correspond to the last color in the array and `zmax` will
+ correspond to the first color.
+
+ The 'reversescale' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["reversescale"]
+
+ @reversescale.setter
+ def reversescale(self, val):
+ self["reversescale"] = val
+
+ # showlegend
+ # ----------
+ @property
+ def showlegend(self):
+ """
+ Determines whether or not an item corresponding to this trace
+ is shown in the legend.
+
+ The 'showlegend' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["showlegend"]
+
+ @showlegend.setter
+ def showlegend(self, val):
+ self["showlegend"] = val
+
+ # showscale
+ # ---------
+ @property
+ def showscale(self):
+ """
+ Determines whether or not a colorbar is displayed for this
+ trace.
+
+ The 'showscale' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["showscale"]
+
+ @showscale.setter
+ def showscale(self, val):
+ self["showscale"] = val
+
+ # stream
+ # ------
+ @property
+ def stream(self):
+ """
+ The 'stream' property is an instance of Stream
+ that may be specified as:
+ - An instance of :class:`plotly.graph_objs.densitymap.Stream`
+ - A dict of string/value properties that will be passed
+ to the Stream constructor
+
+ Supported dict properties:
+
+ maxpoints
+ Sets the maximum number of points to keep on
+ the plots from an incoming stream. If
+ `maxpoints` is set to 50, only the newest 50
+ points will be displayed on the plot.
+ token
+ The stream id number links a data trace on a
+ plot with a stream. See https://chart-
+ studio.plotly.com/settings for more details.
+
+ Returns
+ -------
+ plotly.graph_objs.densitymap.Stream
+ """
+ return self["stream"]
+
+ @stream.setter
+ def stream(self, val):
+ self["stream"] = val
+
+ # subplot
+ # -------
+ @property
+ def subplot(self):
+ """
+ Sets a reference between this trace's data coordinates and a
+ map subplot. If "map" (the default value), the data refer to
+ `layout.map`. If "map2", the data refer to `layout.map2`, and
+ so on.
+
+ The 'subplot' property is an identifier of a particular
+ subplot, of type 'map', that may be specified as the string 'map'
+ optionally followed by an integer >= 1
+ (e.g. 'map', 'map1', 'map2', 'map3', etc.)
+
+ Returns
+ -------
+ str
+ """
+ return self["subplot"]
+
+ @subplot.setter
+ def subplot(self, val):
+ self["subplot"] = val
+
+ # text
+ # ----
+ @property
+ def text(self):
+ """
+ Sets text elements associated with each (lon,lat) pair If a
+ single string, the same string appears over all the data
+ points. If an array of string, the items are mapped in order to
+ the this trace's (lon,lat) coordinates. If trace `hoverinfo`
+ contains a "text" flag and "hovertext" is not set, these
+ elements will be seen in the hover labels.
+
+ The 'text' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+ - A tuple, list, or one-dimensional numpy array of the above
+
+ Returns
+ -------
+ str|numpy.ndarray
+ """
+ return self["text"]
+
+ @text.setter
+ def text(self, val):
+ self["text"] = val
+
+ # textsrc
+ # -------
+ @property
+ def textsrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `text`.
+
+ The 'textsrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["textsrc"]
+
+ @textsrc.setter
+ def textsrc(self, val):
+ self["textsrc"] = val
+
+ # uid
+ # ---
+ @property
+ def uid(self):
+ """
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and transitions.
+
+ The 'uid' property is a string and must be specified as:
+ - A string
+ - A number that will be converted to a string
+
+ Returns
+ -------
+ str
+ """
+ return self["uid"]
+
+ @uid.setter
+ def uid(self, val):
+ self["uid"] = val
+
+ # uirevision
+ # ----------
+ @property
+ def uirevision(self):
+ """
+ Controls persistence of some user-driven changes to the trace:
+ `constraintrange` in `parcoords` traces, as well as some
+ `editable: true` modifications such as `name` and
+ `colorbar.title`. Defaults to `layout.uirevision`. Note that
+ other user-driven trace attribute changes are controlled by
+ `layout` attributes: `trace.visible` is controlled by
+ `layout.legend.uirevision`, `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)` (accessible
+ with `config: {editable: true}`) is controlled by
+ `layout.editrevision`. Trace changes are tracked by `uid`,
+ which only falls back on trace index if no `uid` is provided.
+ So if your app can add/remove traces before the end of the
+ `data` array, such that the same trace has a different index,
+ you can still preserve user-driven changes if you give each
+ trace a `uid` that stays with it as it moves.
+
+ The 'uirevision' property accepts values of any type
+
+ Returns
+ -------
+ Any
+ """
+ return self["uirevision"]
+
+ @uirevision.setter
+ def uirevision(self, val):
+ self["uirevision"] = val
+
+ # visible
+ # -------
+ @property
+ def visible(self):
+ """
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as a
+ legend item (provided that the legend itself is visible).
+
+ The 'visible' property is an enumeration that may be specified as:
+ - One of the following enumeration values:
+ [True, False, 'legendonly']
+
+ Returns
+ -------
+ Any
+ """
+ return self["visible"]
+
+ @visible.setter
+ def visible(self, val):
+ self["visible"] = val
+
+ # z
+ # -
+ @property
+ def z(self):
+ """
+ Sets the points' weight. For example, a value of 10 would be
+ equivalent to having 10 points of weight 1 in the same spot
+
+ The 'z' property is an array that may be specified as a tuple,
+ list, numpy array, or pandas Series
+
+ Returns
+ -------
+ numpy.ndarray
+ """
+ return self["z"]
+
+ @z.setter
+ def z(self, val):
+ self["z"] = val
+
+ # zauto
+ # -----
+ @property
+ def zauto(self):
+ """
+ Determines whether or not the color domain is computed with
+ respect to the input data (here in `z`) or the bounds set in
+ `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
+ are set by the user.
+
+ The 'zauto' property must be specified as a bool
+ (either True, or False)
+
+ Returns
+ -------
+ bool
+ """
+ return self["zauto"]
+
+ @zauto.setter
+ def zauto(self, val):
+ self["zauto"] = val
+
+ # zmax
+ # ----
+ @property
+ def zmax(self):
+ """
+ Sets the upper bound of the color domain. Value should have the
+ same units as in `z` and if set, `zmin` must be set as well.
+
+ The 'zmax' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ int|float
+ """
+ return self["zmax"]
+
+ @zmax.setter
+ def zmax(self, val):
+ self["zmax"] = val
+
+ # zmid
+ # ----
+ @property
+ def zmid(self):
+ """
+ Sets the mid-point of the color domain by scaling `zmin` and/or
+ `zmax` to be equidistant to this point. Value should have the
+ same units as in `z`. Has no effect when `zauto` is `false`.
+
+ The 'zmid' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ int|float
+ """
+ return self["zmid"]
+
+ @zmid.setter
+ def zmid(self, val):
+ self["zmid"] = val
+
+ # zmin
+ # ----
+ @property
+ def zmin(self):
+ """
+ Sets the lower bound of the color domain. Value should have the
+ same units as in `z` and if set, `zmax` must be set as well.
+
+ The 'zmin' property is a number and may be specified as:
+ - An int or float
+
+ Returns
+ -------
+ int|float
+ """
+ return self["zmin"]
+
+ @zmin.setter
+ def zmin(self, val):
+ self["zmin"] = val
+
+ # zsrc
+ # ----
+ @property
+ def zsrc(self):
+ """
+ Sets the source reference on Chart Studio Cloud for `z`.
+
+ The 'zsrc' property must be specified as a string or
+ as a plotly.grid_objs.Column object
+
+ Returns
+ -------
+ str
+ """
+ return self["zsrc"]
+
+ @zsrc.setter
+ def zsrc(self, val):
+ self["zsrc"] = val
+
+ # type
+ # ----
+ @property
+ def type(self):
+ return self._props["type"]
+
+ # Self properties description
+ # ---------------------------
+ @property
+ def _prop_descriptions(self):
+ return """\
+ autocolorscale
+ Determines whether the colorscale is a default palette
+ (`autocolorscale: true`) or the palette determined by
+ `colorscale`. In case `colorscale` is unspecified or
+ `autocolorscale` is true, the default palette will be
+ chosen according to whether numbers in the `color`
+ array are all positive, all negative or mixed.
+ below
+ Determines if the densitymap trace will be inserted
+ before the layer with the specified ID. By default,
+ densitymap traces are placed below the first layer of
+ type symbol If set to '', the layer will be inserted
+ above every existing layer.
+ coloraxis
+ Sets a reference to a shared color axis. References to
+ these shared color axes are "coloraxis", "coloraxis2",
+ "coloraxis3", etc. Settings for these shared color axes
+ are set in the layout, under `layout.coloraxis`,
+ `layout.coloraxis2`, etc. Note that multiple color
+ scales can be linked to the same color axis.
+ colorbar
+ :class:`plotly.graph_objects.densitymap.ColorBar`
+ instance or dict with compatible properties
+ colorscale
+ Sets the colorscale. The colorscale must be an array
+ containing arrays mapping a normalized value to an rgb,
+ rgba, hex, hsl, hsv, or named color string. At minimum,
+ a mapping for the lowest (0) and highest (1) values are
+ required. For example, `[[0, 'rgb(0,0,255)'], [1,
+ 'rgb(255,0,0)']]`. To control the bounds of the
+ colorscale in color space, use `zmin` and `zmax`.
+ Alternatively, `colorscale` may be a palette name
+ string of the following list: Blackbody,Bluered,Blues,C
+ ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
+ and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
+ customdata
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note
+ that, "scatter" traces also appends customdata items in
+ the markers DOM elements
+ customdatasrc
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+ hoverinfo
+ Determines which trace information appear on hover. If
+ `none` or `skip` are set, no information is displayed
+ upon hovering. But, if `none` is set, click and hover
+ events are still fired.
+ hoverinfosrc
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+ hoverlabel
+ :class:`plotly.graph_objects.densitymap.Hoverlabel`
+ instance or dict with compatible properties
+ hovertemplate
+ Template string used for rendering the information that
+ appear on hover box. Note that this will override
+ `hoverinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}" as well as %{xother}, {%_xother},
+ {%_xother_}, {%xother_}. When showing info for several
+ points, "xother" will be added to those with different
+ x positions from the first point. An underscore before
+ or after "(x|y)other" will add a space on that side,
+ only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for
+ example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. The variables available in
+ `hovertemplate` are the ones emitted as event data
+ described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-
+ data. Additionally, every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Anything contained in tag `` is
+ displayed in the secondary box, for example
+ "{fullData.name}". To hide the secondary
+ box completely, use an empty tag ``.
+ hovertemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+ hovertext
+ Sets hover text elements associated with each (lon,lat)
+ pair If a single string, the same string appears over
+ all the data points. If an array of string, the items
+ are mapped in order to the this trace's (lon,lat)
+ coordinates. To be seen, trace `hoverinfo` must contain
+ a "text" flag.
+ hovertextsrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
+ ids
+ Assigns id labels to each datum. These ids for object
+ constancy of data points during animation. Should be an
+ array of strings, not numbers or any other type.
+ idssrc
+ Sets the source reference on Chart Studio Cloud for
+ `ids`.
+ lat
+ Sets the latitude coordinates (in degrees North).
+ latsrc
+ Sets the source reference on Chart Studio Cloud for
+ `lat`.
+ legend
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2",
+ "legend3", etc. Settings for these legends are set in
+ the layout, under `layout.legend`, `layout.legend2`,
+ etc.
+ legendgroup
+ Sets the legend group for this trace. Traces and shapes
+ part of the same legend group hide/show at the same
+ time when toggling legend items.
+ legendgrouptitle
+ :class:`plotly.graph_objects.densitymap.Legendgrouptitl
+ e` instance or dict with compatible properties
+ legendrank
+ Sets the legend rank for this trace. Items and groups
+ with smaller ranks are presented on top/left side while
+ with "reversed" `legend.traceorder` they are on
+ bottom/right side. The default legendrank is 1000, so
+ that you can use ranks less than 1000 to place certain
+ items before all unranked items, and ranks greater than
+ 1000 to go after all unranked items. When having
+ unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and
+ layout.
+ legendwidth
+ Sets the width (in px or fraction) of the legend for
+ this trace.
+ lon
+ Sets the longitude coordinates (in degrees East).
+ lonsrc
+ Sets the source reference on Chart Studio Cloud for
+ `lon`.
+ meta
+ Assigns extra meta information associated with this
+ trace that can be used in various text attributes.
+ Attributes such as trace `name`, graph, axis and
+ colorbar `title.text`, annotation `text`
+ `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta`
+ values in an attribute in the same trace, simply use
+ `%{meta[i]}` where `i` is the index or key of the
+ `meta` item in question. To access trace `meta` in
+ layout attributes, use `%{data[n[.meta[i]}` where `i`
+ is the index or key of the `meta` and `n` is the trace
+ index.
+ metasrc
+ Sets the source reference on Chart Studio Cloud for
+ `meta`.
+ name
+ Sets the trace name. The trace name appears as the
+ legend item and on hover.
+ opacity
+ Sets the opacity of the trace.
+ radius
+ Sets the radius of influence of one `lon` / `lat` point
+ in pixels. Increasing the value makes the densitymap
+ trace smoother, but less detailed.
+ radiussrc
+ Sets the source reference on Chart Studio Cloud for
+ `radius`.
+ reversescale
+ Reverses the color mapping if true. If true, `zmin`
+ will correspond to the last color in the array and
+ `zmax` will correspond to the first color.
+ showlegend
+ Determines whether or not an item corresponding to this
+ trace is shown in the legend.
+ showscale
+ Determines whether or not a colorbar is displayed for
+ this trace.
+ stream
+ :class:`plotly.graph_objects.densitymap.Stream`
+ instance or dict with compatible properties
+ subplot
+ Sets a reference between this trace's data coordinates
+ and a map subplot. If "map" (the default value), the
+ data refer to `layout.map`. If "map2", the data refer
+ to `layout.map2`, and so on.
+ text
+ Sets text elements associated with each (lon,lat) pair
+ If a single string, the same string appears over all
+ the data points. If an array of string, the items are
+ mapped in order to the this trace's (lon,lat)
+ coordinates. If trace `hoverinfo` contains a "text"
+ flag and "hovertext" is not set, these elements will be
+ seen in the hover labels.
+ textsrc
+ Sets the source reference on Chart Studio Cloud for
+ `text`.
+ uid
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and
+ transitions.
+ uirevision
+ Controls persistence of some user-driven changes to the
+ trace: `constraintrange` in `parcoords` traces, as well
+ as some `editable: true` modifications such as `name`
+ and `colorbar.title`. Defaults to `layout.uirevision`.
+ Note that other user-driven trace attribute changes are
+ controlled by `layout` attributes: `trace.visible` is
+ controlled by `layout.legend.uirevision`,
+ `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)`
+ (accessible with `config: {editable: true}`) is
+ controlled by `layout.editrevision`. Trace changes are
+ tracked by `uid`, which only falls back on trace index
+ if no `uid` is provided. So if your app can add/remove
+ traces before the end of the `data` array, such that
+ the same trace has a different index, you can still
+ preserve user-driven changes if you give each trace a
+ `uid` that stays with it as it moves.
+ visible
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as
+ a legend item (provided that the legend itself is
+ visible).
+ z
+ Sets the points' weight. For example, a value of 10
+ would be equivalent to having 10 points of weight 1 in
+ the same spot
+ zauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here in `z`) or the
+ bounds set in `zmin` and `zmax` Defaults to `false`
+ when `zmin` and `zmax` are set by the user.
+ zmax
+ Sets the upper bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmin` must
+ be set as well.
+ zmid
+ Sets the mid-point of the color domain by scaling
+ `zmin` and/or `zmax` to be equidistant to this point.
+ Value should have the same units as in `z`. Has no
+ effect when `zauto` is `false`.
+ zmin
+ Sets the lower bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmax` must
+ be set as well.
+ zsrc
+ Sets the source reference on Chart Studio Cloud for
+ `z`.
+ """
+
+ def __init__(
+ self,
+ arg=None,
+ autocolorscale=None,
+ below=None,
+ coloraxis=None,
+ colorbar=None,
+ colorscale=None,
+ customdata=None,
+ customdatasrc=None,
+ hoverinfo=None,
+ hoverinfosrc=None,
+ hoverlabel=None,
+ hovertemplate=None,
+ hovertemplatesrc=None,
+ hovertext=None,
+ hovertextsrc=None,
+ ids=None,
+ idssrc=None,
+ lat=None,
+ latsrc=None,
+ legend=None,
+ legendgroup=None,
+ legendgrouptitle=None,
+ legendrank=None,
+ legendwidth=None,
+ lon=None,
+ lonsrc=None,
+ meta=None,
+ metasrc=None,
+ name=None,
+ opacity=None,
+ radius=None,
+ radiussrc=None,
+ reversescale=None,
+ showlegend=None,
+ showscale=None,
+ stream=None,
+ subplot=None,
+ text=None,
+ textsrc=None,
+ uid=None,
+ uirevision=None,
+ visible=None,
+ z=None,
+ zauto=None,
+ zmax=None,
+ zmid=None,
+ zmin=None,
+ zsrc=None,
+ **kwargs,
+ ):
+ """
+ Construct a new Densitymap object
+
+ Draws a bivariate kernel density estimation with a Gaussian
+ kernel from `lon` and `lat` coordinates and optional `z` values
+ using a colorscale.
+
+ Parameters
+ ----------
+ arg
+ dict of properties compatible with this constructor or
+ an instance of :class:`plotly.graph_objs.Densitymap`
+ autocolorscale
+ Determines whether the colorscale is a default palette
+ (`autocolorscale: true`) or the palette determined by
+ `colorscale`. In case `colorscale` is unspecified or
+ `autocolorscale` is true, the default palette will be
+ chosen according to whether numbers in the `color`
+ array are all positive, all negative or mixed.
+ below
+ Determines if the densitymap trace will be inserted
+ before the layer with the specified ID. By default,
+ densitymap traces are placed below the first layer of
+ type symbol If set to '', the layer will be inserted
+ above every existing layer.
+ coloraxis
+ Sets a reference to a shared color axis. References to
+ these shared color axes are "coloraxis", "coloraxis2",
+ "coloraxis3", etc. Settings for these shared color axes
+ are set in the layout, under `layout.coloraxis`,
+ `layout.coloraxis2`, etc. Note that multiple color
+ scales can be linked to the same color axis.
+ colorbar
+ :class:`plotly.graph_objects.densitymap.ColorBar`
+ instance or dict with compatible properties
+ colorscale
+ Sets the colorscale. The colorscale must be an array
+ containing arrays mapping a normalized value to an rgb,
+ rgba, hex, hsl, hsv, or named color string. At minimum,
+ a mapping for the lowest (0) and highest (1) values are
+ required. For example, `[[0, 'rgb(0,0,255)'], [1,
+ 'rgb(255,0,0)']]`. To control the bounds of the
+ colorscale in color space, use `zmin` and `zmax`.
+ Alternatively, `colorscale` may be a palette name
+ string of the following list: Blackbody,Bluered,Blues,C
+ ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
+ and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
+ customdata
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note
+ that, "scatter" traces also appends customdata items in
+ the markers DOM elements
+ customdatasrc
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+ hoverinfo
+ Determines which trace information appear on hover. If
+ `none` or `skip` are set, no information is displayed
+ upon hovering. But, if `none` is set, click and hover
+ events are still fired.
+ hoverinfosrc
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+ hoverlabel
+ :class:`plotly.graph_objects.densitymap.Hoverlabel`
+ instance or dict with compatible properties
+ hovertemplate
+ Template string used for rendering the information that
+ appear on hover box. Note that this will override
+ `hoverinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}" as well as %{xother}, {%_xother},
+ {%_xother_}, {%xother_}. When showing info for several
+ points, "xother" will be added to those with different
+ x positions from the first point. An underscore before
+ or after "(x|y)other" will add a space on that side,
+ only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for
+ example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. The variables available in
+ `hovertemplate` are the ones emitted as event data
+ described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-
+ data. Additionally, every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Anything contained in tag `` is
+ displayed in the secondary box, for example
+ "{fullData.name}". To hide the secondary
+ box completely, use an empty tag ``.
+ hovertemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+ hovertext
+ Sets hover text elements associated with each (lon,lat)
+ pair If a single string, the same string appears over
+ all the data points. If an array of string, the items
+ are mapped in order to the this trace's (lon,lat)
+ coordinates. To be seen, trace `hoverinfo` must contain
+ a "text" flag.
+ hovertextsrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
+ ids
+ Assigns id labels to each datum. These ids for object
+ constancy of data points during animation. Should be an
+ array of strings, not numbers or any other type.
+ idssrc
+ Sets the source reference on Chart Studio Cloud for
+ `ids`.
+ lat
+ Sets the latitude coordinates (in degrees North).
+ latsrc
+ Sets the source reference on Chart Studio Cloud for
+ `lat`.
+ legend
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2",
+ "legend3", etc. Settings for these legends are set in
+ the layout, under `layout.legend`, `layout.legend2`,
+ etc.
+ legendgroup
+ Sets the legend group for this trace. Traces and shapes
+ part of the same legend group hide/show at the same
+ time when toggling legend items.
+ legendgrouptitle
+ :class:`plotly.graph_objects.densitymap.Legendgrouptitl
+ e` instance or dict with compatible properties
+ legendrank
+ Sets the legend rank for this trace. Items and groups
+ with smaller ranks are presented on top/left side while
+ with "reversed" `legend.traceorder` they are on
+ bottom/right side. The default legendrank is 1000, so
+ that you can use ranks less than 1000 to place certain
+ items before all unranked items, and ranks greater than
+ 1000 to go after all unranked items. When having
+ unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and
+ layout.
+ legendwidth
+ Sets the width (in px or fraction) of the legend for
+ this trace.
+ lon
+ Sets the longitude coordinates (in degrees East).
+ lonsrc
+ Sets the source reference on Chart Studio Cloud for
+ `lon`.
+ meta
+ Assigns extra meta information associated with this
+ trace that can be used in various text attributes.
+ Attributes such as trace `name`, graph, axis and
+ colorbar `title.text`, annotation `text`
+ `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta`
+ values in an attribute in the same trace, simply use
+ `%{meta[i]}` where `i` is the index or key of the
+ `meta` item in question. To access trace `meta` in
+ layout attributes, use `%{data[n[.meta[i]}` where `i`
+ is the index or key of the `meta` and `n` is the trace
+ index.
+ metasrc
+ Sets the source reference on Chart Studio Cloud for
+ `meta`.
+ name
+ Sets the trace name. The trace name appears as the
+ legend item and on hover.
+ opacity
+ Sets the opacity of the trace.
+ radius
+ Sets the radius of influence of one `lon` / `lat` point
+ in pixels. Increasing the value makes the densitymap
+ trace smoother, but less detailed.
+ radiussrc
+ Sets the source reference on Chart Studio Cloud for
+ `radius`.
+ reversescale
+ Reverses the color mapping if true. If true, `zmin`
+ will correspond to the last color in the array and
+ `zmax` will correspond to the first color.
+ showlegend
+ Determines whether or not an item corresponding to this
+ trace is shown in the legend.
+ showscale
+ Determines whether or not a colorbar is displayed for
+ this trace.
+ stream
+ :class:`plotly.graph_objects.densitymap.Stream`
+ instance or dict with compatible properties
+ subplot
+ Sets a reference between this trace's data coordinates
+ and a map subplot. If "map" (the default value), the
+ data refer to `layout.map`. If "map2", the data refer
+ to `layout.map2`, and so on.
+ text
+ Sets text elements associated with each (lon,lat) pair
+ If a single string, the same string appears over all
+ the data points. If an array of string, the items are
+ mapped in order to the this trace's (lon,lat)
+ coordinates. If trace `hoverinfo` contains a "text"
+ flag and "hovertext" is not set, these elements will be
+ seen in the hover labels.
+ textsrc
+ Sets the source reference on Chart Studio Cloud for
+ `text`.
+ uid
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and
+ transitions.
+ uirevision
+ Controls persistence of some user-driven changes to the
+ trace: `constraintrange` in `parcoords` traces, as well
+ as some `editable: true` modifications such as `name`
+ and `colorbar.title`. Defaults to `layout.uirevision`.
+ Note that other user-driven trace attribute changes are
+ controlled by `layout` attributes: `trace.visible` is
+ controlled by `layout.legend.uirevision`,
+ `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)`
+ (accessible with `config: {editable: true}`) is
+ controlled by `layout.editrevision`. Trace changes are
+ tracked by `uid`, which only falls back on trace index
+ if no `uid` is provided. So if your app can add/remove
+ traces before the end of the `data` array, such that
+ the same trace has a different index, you can still
+ preserve user-driven changes if you give each trace a
+ `uid` that stays with it as it moves.
+ visible
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as
+ a legend item (provided that the legend itself is
+ visible).
+ z
+ Sets the points' weight. For example, a value of 10
+ would be equivalent to having 10 points of weight 1 in
+ the same spot
+ zauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here in `z`) or the
+ bounds set in `zmin` and `zmax` Defaults to `false`
+ when `zmin` and `zmax` are set by the user.
+ zmax
+ Sets the upper bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmin` must
+ be set as well.
+ zmid
+ Sets the mid-point of the color domain by scaling
+ `zmin` and/or `zmax` to be equidistant to this point.
+ Value should have the same units as in `z`. Has no
+ effect when `zauto` is `false`.
+ zmin
+ Sets the lower bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmax` must
+ be set as well.
+ zsrc
+ Sets the source reference on Chart Studio Cloud for
+ `z`.
+
+ Returns
+ -------
+ Densitymap
+ """
+ super(Densitymap, self).__init__("densitymap")
+
+ if "_parent" in kwargs:
+ self._parent = kwargs["_parent"]
+ return
+
+ # Validate arg
+ # ------------
+ if arg is None:
+ arg = {}
+ elif isinstance(arg, self.__class__):
+ arg = arg.to_plotly_json()
+ elif isinstance(arg, dict):
+ arg = _copy.copy(arg)
+ else:
+ raise ValueError(
+ """\
+The first argument to the plotly.graph_objs.Densitymap
+constructor must be a dict or
+an instance of :class:`plotly.graph_objs.Densitymap`"""
+ )
+
+ # Handle skip_invalid
+ # -------------------
+ self._skip_invalid = kwargs.pop("skip_invalid", False)
+ self._validate = kwargs.pop("_validate", True)
+
+ # Populate data dict with properties
+ # ----------------------------------
+ _v = arg.pop("autocolorscale", None)
+ _v = autocolorscale if autocolorscale is not None else _v
+ if _v is not None:
+ self["autocolorscale"] = _v
+ _v = arg.pop("below", None)
+ _v = below if below is not None else _v
+ if _v is not None:
+ self["below"] = _v
+ _v = arg.pop("coloraxis", None)
+ _v = coloraxis if coloraxis is not None else _v
+ if _v is not None:
+ self["coloraxis"] = _v
+ _v = arg.pop("colorbar", None)
+ _v = colorbar if colorbar is not None else _v
+ if _v is not None:
+ self["colorbar"] = _v
+ _v = arg.pop("colorscale", None)
+ _v = colorscale if colorscale is not None else _v
+ if _v is not None:
+ self["colorscale"] = _v
+ _v = arg.pop("customdata", None)
+ _v = customdata if customdata is not None else _v
+ if _v is not None:
+ self["customdata"] = _v
+ _v = arg.pop("customdatasrc", None)
+ _v = customdatasrc if customdatasrc is not None else _v
+ if _v is not None:
+ self["customdatasrc"] = _v
+ _v = arg.pop("hoverinfo", None)
+ _v = hoverinfo if hoverinfo is not None else _v
+ if _v is not None:
+ self["hoverinfo"] = _v
+ _v = arg.pop("hoverinfosrc", None)
+ _v = hoverinfosrc if hoverinfosrc is not None else _v
+ if _v is not None:
+ self["hoverinfosrc"] = _v
+ _v = arg.pop("hoverlabel", None)
+ _v = hoverlabel if hoverlabel is not None else _v
+ if _v is not None:
+ self["hoverlabel"] = _v
+ _v = arg.pop("hovertemplate", None)
+ _v = hovertemplate if hovertemplate is not None else _v
+ if _v is not None:
+ self["hovertemplate"] = _v
+ _v = arg.pop("hovertemplatesrc", None)
+ _v = hovertemplatesrc if hovertemplatesrc is not None else _v
+ if _v is not None:
+ self["hovertemplatesrc"] = _v
+ _v = arg.pop("hovertext", None)
+ _v = hovertext if hovertext is not None else _v
+ if _v is not None:
+ self["hovertext"] = _v
+ _v = arg.pop("hovertextsrc", None)
+ _v = hovertextsrc if hovertextsrc is not None else _v
+ if _v is not None:
+ self["hovertextsrc"] = _v
+ _v = arg.pop("ids", None)
+ _v = ids if ids is not None else _v
+ if _v is not None:
+ self["ids"] = _v
+ _v = arg.pop("idssrc", None)
+ _v = idssrc if idssrc is not None else _v
+ if _v is not None:
+ self["idssrc"] = _v
+ _v = arg.pop("lat", None)
+ _v = lat if lat is not None else _v
+ if _v is not None:
+ self["lat"] = _v
+ _v = arg.pop("latsrc", None)
+ _v = latsrc if latsrc is not None else _v
+ if _v is not None:
+ self["latsrc"] = _v
+ _v = arg.pop("legend", None)
+ _v = legend if legend is not None else _v
+ if _v is not None:
+ self["legend"] = _v
+ _v = arg.pop("legendgroup", None)
+ _v = legendgroup if legendgroup is not None else _v
+ if _v is not None:
+ self["legendgroup"] = _v
+ _v = arg.pop("legendgrouptitle", None)
+ _v = legendgrouptitle if legendgrouptitle is not None else _v
+ if _v is not None:
+ self["legendgrouptitle"] = _v
+ _v = arg.pop("legendrank", None)
+ _v = legendrank if legendrank is not None else _v
+ if _v is not None:
+ self["legendrank"] = _v
+ _v = arg.pop("legendwidth", None)
+ _v = legendwidth if legendwidth is not None else _v
+ if _v is not None:
+ self["legendwidth"] = _v
+ _v = arg.pop("lon", None)
+ _v = lon if lon is not None else _v
+ if _v is not None:
+ self["lon"] = _v
+ _v = arg.pop("lonsrc", None)
+ _v = lonsrc if lonsrc is not None else _v
+ if _v is not None:
+ self["lonsrc"] = _v
+ _v = arg.pop("meta", None)
+ _v = meta if meta is not None else _v
+ if _v is not None:
+ self["meta"] = _v
+ _v = arg.pop("metasrc", None)
+ _v = metasrc if metasrc is not None else _v
+ if _v is not None:
+ self["metasrc"] = _v
+ _v = arg.pop("name", None)
+ _v = name if name is not None else _v
+ if _v is not None:
+ self["name"] = _v
+ _v = arg.pop("opacity", None)
+ _v = opacity if opacity is not None else _v
+ if _v is not None:
+ self["opacity"] = _v
+ _v = arg.pop("radius", None)
+ _v = radius if radius is not None else _v
+ if _v is not None:
+ self["radius"] = _v
+ _v = arg.pop("radiussrc", None)
+ _v = radiussrc if radiussrc is not None else _v
+ if _v is not None:
+ self["radiussrc"] = _v
+ _v = arg.pop("reversescale", None)
+ _v = reversescale if reversescale is not None else _v
+ if _v is not None:
+ self["reversescale"] = _v
+ _v = arg.pop("showlegend", None)
+ _v = showlegend if showlegend is not None else _v
+ if _v is not None:
+ self["showlegend"] = _v
+ _v = arg.pop("showscale", None)
+ _v = showscale if showscale is not None else _v
+ if _v is not None:
+ self["showscale"] = _v
+ _v = arg.pop("stream", None)
+ _v = stream if stream is not None else _v
+ if _v is not None:
+ self["stream"] = _v
+ _v = arg.pop("subplot", None)
+ _v = subplot if subplot is not None else _v
+ if _v is not None:
+ self["subplot"] = _v
+ _v = arg.pop("text", None)
+ _v = text if text is not None else _v
+ if _v is not None:
+ self["text"] = _v
+ _v = arg.pop("textsrc", None)
+ _v = textsrc if textsrc is not None else _v
+ if _v is not None:
+ self["textsrc"] = _v
+ _v = arg.pop("uid", None)
+ _v = uid if uid is not None else _v
+ if _v is not None:
+ self["uid"] = _v
+ _v = arg.pop("uirevision", None)
+ _v = uirevision if uirevision is not None else _v
+ if _v is not None:
+ self["uirevision"] = _v
+ _v = arg.pop("visible", None)
+ _v = visible if visible is not None else _v
+ if _v is not None:
+ self["visible"] = _v
+ _v = arg.pop("z", None)
+ _v = z if z is not None else _v
+ if _v is not None:
+ self["z"] = _v
+ _v = arg.pop("zauto", None)
+ _v = zauto if zauto is not None else _v
+ if _v is not None:
+ self["zauto"] = _v
+ _v = arg.pop("zmax", None)
+ _v = zmax if zmax is not None else _v
+ if _v is not None:
+ self["zmax"] = _v
+ _v = arg.pop("zmid", None)
+ _v = zmid if zmid is not None else _v
+ if _v is not None:
+ self["zmid"] = _v
+ _v = arg.pop("zmin", None)
+ _v = zmin if zmin is not None else _v
+ if _v is not None:
+ self["zmin"] = _v
+ _v = arg.pop("zsrc", None)
+ _v = zsrc if zsrc is not None else _v
+ if _v is not None:
+ self["zsrc"] = _v
+
+ # Read-only literals
+ # ------------------
+
+ self._props["type"] = "densitymap"
+ arg.pop("type", None)
+
+ # Process unknown kwargs
+ # ----------------------
+ self._process_kwargs(**dict(arg, **kwargs))
+
+ # Reset skip_invalid
+ # ------------------
+ self._skip_invalid = False
diff --git a/packages/python/plotly/plotly/graph_objs/_densitymapbox.py b/packages/python/plotly/plotly/graph_objs/_densitymapbox.py
index 88a047d767c..10af98c67fe 100644
--- a/packages/python/plotly/plotly/graph_objs/_densitymapbox.py
+++ b/packages/python/plotly/plotly/graph_objs/_densitymapbox.py
@@ -1234,9 +1234,12 @@ def stream(self, val):
@property
def subplot(self):
"""
- Sets a reference between this trace's data coordinates and a
- mapbox subplot. If "mapbox" (the default value), the data refer
- to `layout.mapbox`. If "mapbox2", the data refer to
+ mapbox subplots and traces are deprecated! Please consider
+ switching to `map` subplots and traces. Learn more at:
+ https://plotly.com/javascript/maplibre-migration/ Sets a
+ reference between this trace's data coordinates and a mapbox
+ subplot. If "mapbox" (the default value), the data refer to
+ `layout.mapbox`. If "mapbox2", the data refer to
`layout.mapbox2`, and so on.
The 'subplot' property is an identifier of a particular
@@ -1699,10 +1702,14 @@ def _prop_descriptions(self):
: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),
- the data refer to `layout.mapbox`. If "mapbox2", the
- data refer to `layout.mapbox2`, and so on.
+ mapbox subplots and traces are deprecated! Please
+ consider switching to `map` subplots and traces. Learn
+ more at: https://plotly.com/javascript/maplibre-
+ migration/ Sets a reference between this trace's data
+ coordinates and a mapbox subplot. If "mapbox" (the
+ default value), the data refer to `layout.mapbox`. If
+ "mapbox2", the data refer to `layout.mapbox2`, and so
+ on.
text
Sets text elements associated with each (lon,lat) pair
If a single string, the same string appears over all
@@ -1823,9 +1830,12 @@ def __init__(
"""
Construct a new Densitymapbox object
- Draws a bivariate kernel density estimation with a Gaussian
- kernel from `lon` and `lat` coordinates and optional `z` values
- using a colorscale.
+ "densitymapbox" trace is deprecated! Please consider switching
+ to the "densitymap" trace type and `map` subplots. Learn more
+ at: https://plotly.com/javascript/maplibre-migration/ Draws a
+ bivariate kernel density estimation with a Gaussian kernel from
+ `lon` and `lat` coordinates and optional `z` values using a
+ colorscale.
Parameters
----------
@@ -2013,10 +2023,14 @@ def __init__(
: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),
- the data refer to `layout.mapbox`. If "mapbox2", the
- data refer to `layout.mapbox2`, and so on.
+ mapbox subplots and traces are deprecated! Please
+ consider switching to `map` subplots and traces. Learn
+ more at: https://plotly.com/javascript/maplibre-
+ migration/ Sets a reference between this trace's data
+ coordinates and a mapbox subplot. If "mapbox" (the
+ default value), the data refer to `layout.mapbox`. If
+ "mapbox2", the data refer to `layout.mapbox2`, and so
+ on.
text
Sets text elements associated with each (lon,lat) pair
If a single string, the same string appears over all
diff --git a/packages/python/plotly/plotly/graph_objs/_figure.py b/packages/python/plotly/plotly/graph_objs/_figure.py
index 957c2d7d688..28ae8bc999b 100644
--- a/packages/python/plotly/plotly/graph_objs/_figure.py
+++ b/packages/python/plotly/plotly/graph_objs/_figure.py
@@ -20,8 +20,9 @@ def __init__(
- A list or tuple of dicts of string/value properties where:
- The 'type' property specifies the trace type
One of: ['bar', 'barpolar', 'box', 'candlestick',
- 'carpet', 'choropleth', 'choroplethmapbox',
- 'cone', 'contour', 'contourcarpet',
+ 'carpet', 'choropleth', 'choroplethmap',
+ 'choroplethmapbox', 'cone', 'contour',
+ 'contourcarpet', 'densitymap',
'densitymapbox', 'funnel', 'funnelarea',
'heatmap', 'heatmapgl', 'histogram',
'histogram2d', 'histogram2dcontour', 'icicle',
@@ -29,11 +30,11 @@ def __init__(
'ohlc', 'parcats', 'parcoords', 'pie',
'pointcloud', 'sankey', 'scatter',
'scatter3d', 'scattercarpet', 'scattergeo',
- 'scattergl', 'scattermapbox', 'scatterpolar',
- 'scatterpolargl', 'scattersmith',
- 'scatterternary', 'splom', 'streamtube',
- 'sunburst', 'surface', 'table', 'treemap',
- 'violin', 'volume', 'waterfall']
+ 'scattergl', 'scattermap', 'scattermapbox',
+ 'scatterpolar', 'scatterpolargl',
+ 'scattersmith', 'scatterternary', 'splom',
+ 'streamtube', 'sunburst', 'surface', 'table',
+ 'treemap', 'violin', 'volume', 'waterfall']
- All remaining properties are passed to the constructor of
the specified trace type
@@ -340,6 +341,9 @@ def __init__(
legend
:class:`plotly.graph_objects.layout.Legend`
instance or dict with compatible properties
+ map
+ :class:`plotly.graph_objects.layout.Map`
+ instance or dict with compatible properties
mapbox
:class:`plotly.graph_objects.layout.Mapbox`
instance or dict with compatible properties
@@ -3870,7 +3874,7 @@ def add_choropleth(
)
return self.add_trace(new_trace, row=row, col=col)
- def add_choroplethmapbox(
+ def add_choroplethmap(
self,
autocolorscale=None,
below=None,
@@ -3925,7 +3929,7 @@ def add_choroplethmapbox(
**kwargs,
) -> "Figure":
"""
- Add a new Choroplethmapbox trace
+ Add a new Choroplethmap trace
GeoJSON features to be filled are set in `geojson` The data
that describes the choropleth value-to-color mapping is set in
@@ -3943,9 +3947,9 @@ def add_choroplethmapbox(
below
Determines if the choropleth polygons will be inserted
before the layer with the specified ID. By default,
- choroplethmapbox traces are placed above the water
- layers. If set to '', the layer will be inserted above
- every existing layer.
+ choroplethmap traces are placed above the water layers.
+ If set to '', the layer will be inserted above every
+ existing layer.
coloraxis
Sets a reference to a shared color axis. References to
these shared color axes are "coloraxis", "coloraxis2",
@@ -3954,7 +3958,7 @@ def add_choroplethmapbox(
`layout.coloraxis2`, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar
- :class:`plotly.graph_objects.choroplethmapbox.ColorBar`
+ :class:`plotly.graph_objects.choroplethmap.ColorBar`
instance or dict with compatible properties
colorscale
Sets the colorscale. The colorscale must be an array
@@ -3995,8 +3999,8 @@ def add_choroplethmapbox(
Sets the source reference on Chart Studio Cloud for
`hoverinfo`.
hoverlabel
- :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe
- l` instance or dict with compatible properties
+ :class:`plotly.graph_objects.choroplethmap.Hoverlabel`
+ instance or dict with compatible properties
hovertemplate
Template string used for rendering the information that
appear on hover box. Note that this will override
@@ -4053,8 +4057,8 @@ def add_choroplethmapbox(
part of the same legend group hide/show at the same
time when toggling legend items.
legendgrouptitle
- :class:`plotly.graph_objects.choroplethmapbox.Legendgro
- uptitle` instance or dict with compatible properties
+ :class:`plotly.graph_objects.choroplethmap.Legendgroupt
+ itle` instance or dict with compatible properties
legendrank
Sets the legend rank for this trace. Items and groups
with smaller ranks are presented on top/left side while
@@ -4076,7 +4080,7 @@ def add_choroplethmapbox(
Sets the source reference on Chart Studio Cloud for
`locations`.
marker
- :class:`plotly.graph_objects.choroplethmapbox.Marker`
+ :class:`plotly.graph_objects.choroplethmap.Marker`
instance or dict with compatible properties
meta
Assigns extra meta information associated with this
@@ -4102,7 +4106,7 @@ def add_choroplethmapbox(
will correspond to the last color in the array and
`zmax` will correspond to the first color.
selected
- :class:`plotly.graph_objects.choroplethmapbox.Selected`
+ :class:`plotly.graph_objects.choroplethmap.Selected`
instance or dict with compatible properties
selectedpoints
Array containing integer indices of selected points.
@@ -4118,13 +4122,13 @@ def add_choroplethmapbox(
Determines whether or not a colorbar is displayed for
this trace.
stream
- :class:`plotly.graph_objects.choroplethmapbox.Stream`
+ :class:`plotly.graph_objects.choroplethmap.Stream`
instance or dict with compatible properties
subplot
Sets a reference between this trace's data coordinates
- and a mapbox subplot. If "mapbox" (the default value),
- the data refer to `layout.mapbox`. If "mapbox2", the
- data refer to `layout.mapbox2`, and so on.
+ and a map subplot. If "map" (the default value), the
+ data refer to `layout.map`. If "map2", the data refer
+ to `layout.map2`, and so on.
text
Sets the text elements associated with each location.
textsrc
@@ -4153,8 +4157,8 @@ def add_choroplethmapbox(
preserve user-driven changes if you give each trace a
`uid` that stays with it as it moves.
unselected
- :class:`plotly.graph_objects.choroplethmapbox.Unselecte
- d` instance or dict with compatible properties
+ :class:`plotly.graph_objects.choroplethmap.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
@@ -4198,9 +4202,9 @@ def add_choroplethmapbox(
-------
Figure
"""
- from plotly.graph_objs import Choroplethmapbox
+ from plotly.graph_objs import Choroplethmap
- new_trace = Choroplethmapbox(
+ new_trace = Choroplethmap(
autocolorscale=autocolorscale,
below=below,
coloraxis=coloraxis,
@@ -4253,19 +4257,17 @@ def add_choroplethmapbox(
)
return self.add_trace(new_trace, row=row, col=col)
- def add_cone(
+ def add_choroplethmapbox(
self,
- anchor=None,
autocolorscale=None,
- cauto=None,
- cmax=None,
- cmid=None,
- cmin=None,
+ below=None,
coloraxis=None,
colorbar=None,
colorscale=None,
customdata=None,
customdatasrc=None,
+ featureidkey=None,
+ geojson=None,
hoverinfo=None,
hoverinfosrc=None,
hoverlabel=None,
@@ -4280,60 +4282,47 @@ def add_cone(
legendgrouptitle=None,
legendrank=None,
legendwidth=None,
- lighting=None,
- lightposition=None,
+ locations=None,
+ locationssrc=None,
+ marker=None,
meta=None,
metasrc=None,
name=None,
- opacity=None,
reversescale=None,
- scene=None,
+ selected=None,
+ selectedpoints=None,
showlegend=None,
showscale=None,
- sizemode=None,
- sizeref=None,
stream=None,
+ subplot=None,
text=None,
textsrc=None,
- u=None,
- uhoverformat=None,
uid=None,
uirevision=None,
- usrc=None,
- v=None,
- vhoverformat=None,
+ unselected=None,
visible=None,
- vsrc=None,
- w=None,
- whoverformat=None,
- wsrc=None,
- x=None,
- xhoverformat=None,
- xsrc=None,
- y=None,
- yhoverformat=None,
- ysrc=None,
z=None,
- zhoverformat=None,
+ zauto=None,
+ zmax=None,
+ zmid=None,
+ zmin=None,
zsrc=None,
row=None,
col=None,
**kwargs,
) -> "Figure":
"""
- Add a new Cone trace
+ Add a new Choroplethmapbox trace
- Use cone traces to visualize vector fields. Specify a vector
- field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and
- 3 vector component arrays `u`, `v`, `w`. The cones are drawn
- exactly at the positions given by `x`, `y` and `z`.
+ "choroplethmapbox" trace is deprecated! Please consider
+ switching to the "choroplethmap" trace type and `map` subplots.
+ Learn more at: https://plotly.com/javascript/maplibre-
+ migration/ GeoJSON features to be filled are set in `geojson`
+ The data that describes the choropleth value-to-color mapping
+ is set in `locations` and `z`.
Parameters
----------
- anchor
- Sets the cones' anchor with respect to their x/y/z
- positions. Note that "cm" denote the cone's center of
- mass which corresponds to 1/4 from the tail to tip.
autocolorscale
Determines whether the colorscale is a default palette
(`autocolorscale: true`) or the palette determined by
@@ -4341,24 +4330,12 @@ def add_cone(
`autocolorscale` is true, the default palette will be
chosen according to whether numbers in the `color`
array are all positive, all negative or mixed.
- cauto
- Determines whether or not the color domain is computed
- with respect to the input data (here u/v/w norm) or the
- bounds set in `cmin` and `cmax` Defaults to `false`
- when `cmin` and `cmax` are set by the user.
- cmax
- Sets the upper bound of the color domain. Value should
- have the same units as u/v/w norm and if set, `cmin`
- must be set as well.
- cmid
- Sets the mid-point of the color domain by scaling
- `cmin` and/or `cmax` to be equidistant to this point.
- Value should have the same units as u/v/w norm. Has no
- effect when `cauto` is `false`.
- cmin
- Sets the lower bound of the color domain. Value should
- have the same units as u/v/w norm and if set, `cmax`
- must be set as well.
+ below
+ Determines if the choropleth polygons will be inserted
+ before the layer with the specified ID. By default,
+ choroplethmapbox traces are placed above the water
+ layers. If set to '', the layer will be inserted above
+ every existing layer.
coloraxis
Sets a reference to a shared color axis. References to
these shared color axes are "coloraxis", "coloraxis2",
@@ -4367,8 +4344,8 @@ def add_cone(
`layout.coloraxis2`, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar
- :class:`plotly.graph_objects.cone.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,
@@ -4376,7 +4353,7 @@ def add_cone(
a mapping for the lowest (0) and highest (1) values are
required. For example, `[[0, 'rgb(0,0,255)'], [1,
'rgb(255,0,0)']]`. To control the bounds of the
- colorscale in color space, use `cmin` and `cmax`.
+ colorscale in color space, use `zmin` and `zmax`.
Alternatively, `colorscale` may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
@@ -4389,6 +4366,16 @@ def add_cone(
customdatasrc
Sets the source reference on Chart Studio Cloud for
`customdata`.
+ featureidkey
+ Sets the key in GeoJSON features which is used as id to
+ match the items included in the `locations` array.
+ Support nested property, for example "properties.name".
+ geojson
+ Sets the GeoJSON data associated with this trace. It
+ can be set as a valid GeoJSON object or as a URL
+ string. Note that we only accept GeoJSONs of type
+ "FeatureCollection" or "Feature" with geometries of
+ type "Polygon" or "MultiPolygon".
hoverinfo
Determines which trace information appear on hover. If
`none` or `skip` are set, no information is displayed
@@ -4398,8 +4385,8 @@ def add_cone(
Sets the source reference on Chart Studio Cloud for
`hoverinfo`.
hoverlabel
- :class:`plotly.graph_objects.cone.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
@@ -4425,10 +4412,11 @@ def add_cone(
data. Additionally, every attributes that can be
specified per-point (the ones that are `arrayOk: true`)
are available. Finally, the template string has access
- to variable `norm` Anything contained in tag ``
- is displayed in the secondary box, for example
- "{fullData.name}". To hide the secondary
- box completely, use an empty tag ``.
+ to variable `properties` Anything contained in tag
+ `` is displayed in the secondary box, for
+ example "{fullData.name}". To hide the
+ secondary box completely, use an empty tag
+ ``.
hovertemplatesrc
Sets the source reference on Chart Studio Cloud for
`hovertemplate`.
@@ -4455,8 +4443,8 @@ def add_cone(
part of the same legend group hide/show at the same
time when toggling legend items.
legendgrouptitle
- :class:`plotly.graph_objects.cone.Legendgrouptitle`
- instance or dict with compatible properties
+ :class:`plotly.graph_objects.choroplethmapbox.Legendgro
+ uptitle` instance or dict with compatible properties
legendrank
Sets the legend rank for this trace. Items and groups
with smaller ranks are presented on top/left side while
@@ -4471,11 +4459,14 @@ def add_cone(
legendwidth
Sets the width (in px or fraction) of the legend for
this trace.
- lighting
- :class:`plotly.graph_objects.cone.Lighting` instance or
- dict with compatible properties
- lightposition
- :class:`plotly.graph_objects.cone.Lightposition`
+ locations
+ Sets which features found in "geojson" to plot using
+ their feature `id` field.
+ locationssrc
+ Sets the source reference on Chart Studio Cloud for
+ `locations`.
+ marker
+ :class:`plotly.graph_objects.choroplethmapbox.Marker`
instance or dict with compatible properties
meta
Assigns extra meta information associated with this
@@ -4496,68 +4487,43 @@ def add_cone(
name
Sets the trace name. The trace name appears as the
legend item and on hover.
- opacity
- Sets the opacity of the surface. Please note that in
- the case of using high `opacity` values for example a
- value greater than or equal to 0.5 on two surfaces (and
- 0.25 with four surfaces), an overlay of multiple
- transparent surfaces may not perfectly be sorted in
- depth by the webgl API. This behavior may be improved
- in the near future and is subject to change.
reversescale
- Reverses the color mapping if true. If true, `cmin`
+ Reverses the color mapping if true. If true, `zmin`
will correspond to the last color in the array and
- `cmax` will correspond to the first color.
- scene
- Sets a reference between this trace's 3D coordinate
- system and a 3D scene. If "scene" (the default value),
- the (x,y,z) coordinates refer to `layout.scene`. If
- "scene2", the (x,y,z) coordinates refer to
- `layout.scene2`, and so on.
+ `zmax` will correspond to the first color.
+ selected
+ :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.
+ Note that an empty array means an empty selection where
+ the `unselected` are turned on for all points, whereas,
+ any other non-array values means no selection all where
+ the `selected` and `unselected` styles have no effect.
showlegend
Determines whether or not an item corresponding to this
trace is shown in the legend.
showscale
Determines whether or not a colorbar is displayed for
this trace.
- sizemode
- Determines whether `sizeref` is set as a "scaled" (i.e
- unitless) scalar (normalized by the max u/v/w norm in
- the vector field) or as "absolute" value (in the same
- units as the vector field). To display sizes in actual
- vector length use "raw".
- sizeref
- Adjusts the cone size scaling. The size of the cones is
- determined by their u/v/w norm multiplied a factor and
- `sizeref`. This factor (computed internally)
- corresponds to the minimum "time" to travel across two
- successive x/y/z positions at the average velocity of
- those two successive positions. All cones in a given
- trace use the same factor. With `sizemode` set to
- "raw", its default value is 1. With `sizemode` set to
- "scaled", `sizeref` is unitless, its default value is
- 0.5. With `sizemode` set to "absolute", `sizeref` has
- the same units as the u/v/w vector field, its the
- default value is half the sample's maximum vector norm.
stream
- :class:`plotly.graph_objects.cone.Stream` instance or
- dict with compatible properties
+ :class:`plotly.graph_objects.choroplethmapbox.Stream`
+ instance or dict with compatible properties
+ subplot
+ mapbox subplots and traces are deprecated! Please
+ consider switching to `map` subplots and traces. Learn
+ more at: https://plotly.com/javascript/maplibre-
+ migration/ Sets a reference between this trace's data
+ coordinates and a mapbox subplot. If "mapbox" (the
+ default value), the data refer to `layout.mapbox`. If
+ "mapbox2", the data refer to `layout.mapbox2`, and so
+ on.
text
- Sets the text elements associated with the cones. If
- trace `hoverinfo` contains a "text" flag and
- "hovertext" is not set, these elements will be seen in
- the hover labels.
+ Sets the text elements associated with each location.
textsrc
Sets the source reference on Chart Studio Cloud for
`text`.
- u
- Sets the x components of the vector field.
- uhoverformat
- Sets the hover text formatting rulefor `u` using d3
- formatting mini-languages which are very similar to
- those in Python. For numbers, see: https://github.com/d
- 3/d3-format/tree/v1.4.5#d3-format.By default the values
- are formatted using generic number format.
uid
Assign an id to this trace, Use this to provide object
constancy between traces during animations and
@@ -4580,91 +4546,35 @@ def add_cone(
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
`uid` that stays with it as it moves.
- usrc
- Sets the source reference on Chart Studio Cloud for
- `u`.
- v
- Sets the y components of the vector field.
- vhoverformat
- Sets the hover text formatting rulefor `v` using d3
- formatting mini-languages which are very similar to
- those in Python. For numbers, see: https://github.com/d
- 3/d3-format/tree/v1.4.5#d3-format.By default the values
- are formatted using generic number format.
+ unselected
+ :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
a legend item (provided that the legend itself is
visible).
- vsrc
- Sets the source reference on Chart Studio Cloud for
- `v`.
- w
- Sets the z components of the vector field.
- whoverformat
- Sets the hover text formatting rulefor `w` using d3
- formatting mini-languages which are very similar to
- those in Python. For numbers, see: https://github.com/d
- 3/d3-format/tree/v1.4.5#d3-format.By default the values
- are formatted using generic number format.
- wsrc
- Sets the source reference on Chart Studio Cloud for
- `w`.
- x
- Sets the x coordinates of the vector field and of the
- displayed cones.
- xhoverformat
- Sets the hover text formatting rulefor `x` using d3
- formatting mini-languages which are very similar to
- those in Python. For numbers, see:
- https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
- And for dates see: https://github.com/d3/d3-time-
- format/tree/v2.2.3#locale_format. We add two items to
- d3's date formatter: "%h" for half of the year as a
- decimal number as well as "%{n}f" for fractional
- seconds with n digits. For example, *2016-10-13
- 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
- display *09~15~23.46*By default the values are
- formatted using `xaxis.hoverformat`.
- xsrc
- Sets the source reference on Chart Studio Cloud for
- `x`.
- y
- Sets the y coordinates of the vector field and of the
- displayed cones.
- yhoverformat
- Sets the hover text formatting rulefor `y` using d3
- formatting mini-languages which are very similar to
- those in Python. For numbers, see:
- https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
- And for dates see: https://github.com/d3/d3-time-
- format/tree/v2.2.3#locale_format. We add two items to
- d3's date formatter: "%h" for half of the year as a
- decimal number as well as "%{n}f" for fractional
- seconds with n digits. For example, *2016-10-13
- 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
- display *09~15~23.46*By default the values are
- formatted using `yaxis.hoverformat`.
- ysrc
- Sets the source reference on Chart Studio Cloud for
- `y`.
- z
- Sets the z coordinates of the vector field and of the
- displayed cones.
- zhoverformat
- Sets the hover text formatting rulefor `z` using d3
- formatting mini-languages which are very similar to
- those in Python. For numbers, see:
- https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
- And for dates see: https://github.com/d3/d3-time-
- format/tree/v2.2.3#locale_format. We add two items to
- d3's date formatter: "%h" for half of the year as a
- decimal number as well as "%{n}f" for fractional
- seconds with n digits. For example, *2016-10-13
- 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
- display *09~15~23.46*By default the values are
- formatted using `zaxis.hoverformat`.
- zsrc
+ z
+ Sets the color values.
+ zauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here in `z`) or the
+ bounds set in `zmin` and `zmax` Defaults to `false`
+ when `zmin` and `zmax` are set by the user.
+ zmax
+ Sets the upper bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmin` must
+ be set as well.
+ zmid
+ Sets the mid-point of the color domain by scaling
+ `zmin` and/or `zmax` to be equidistant to this point.
+ Value should have the same units as in `z`. Has no
+ effect when `zauto` is `false`.
+ zmin
+ Sets the lower bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmax` must
+ be set as well.
+ zsrc
Sets the source reference on Chart Studio Cloud for
`z`.
row : 'all', int or None (default)
@@ -4682,20 +4592,18 @@ def add_cone(
-------
Figure
"""
- from plotly.graph_objs import Cone
+ from plotly.graph_objs import Choroplethmapbox
- new_trace = Cone(
- anchor=anchor,
+ new_trace = Choroplethmapbox(
autocolorscale=autocolorscale,
- cauto=cauto,
- cmax=cmax,
- cmid=cmid,
- cmin=cmin,
+ below=below,
coloraxis=coloraxis,
colorbar=colorbar,
colorscale=colorscale,
customdata=customdata,
customdatasrc=customdatasrc,
+ featureidkey=featureidkey,
+ geojson=geojson,
hoverinfo=hoverinfo,
hoverinfosrc=hoverinfosrc,
hoverlabel=hoverlabel,
@@ -4710,64 +4618,51 @@ def add_cone(
legendgrouptitle=legendgrouptitle,
legendrank=legendrank,
legendwidth=legendwidth,
- lighting=lighting,
- lightposition=lightposition,
+ locations=locations,
+ locationssrc=locationssrc,
+ marker=marker,
meta=meta,
metasrc=metasrc,
name=name,
- opacity=opacity,
reversescale=reversescale,
- scene=scene,
+ selected=selected,
+ selectedpoints=selectedpoints,
showlegend=showlegend,
showscale=showscale,
- sizemode=sizemode,
- sizeref=sizeref,
stream=stream,
+ subplot=subplot,
text=text,
textsrc=textsrc,
- u=u,
- uhoverformat=uhoverformat,
uid=uid,
uirevision=uirevision,
- usrc=usrc,
- v=v,
- vhoverformat=vhoverformat,
+ unselected=unselected,
visible=visible,
- vsrc=vsrc,
- w=w,
- whoverformat=whoverformat,
- wsrc=wsrc,
- x=x,
- xhoverformat=xhoverformat,
- xsrc=xsrc,
- y=y,
- yhoverformat=yhoverformat,
- ysrc=ysrc,
z=z,
- zhoverformat=zhoverformat,
+ zauto=zauto,
+ zmax=zmax,
+ zmid=zmid,
+ zmin=zmin,
zsrc=zsrc,
**kwargs,
)
return self.add_trace(new_trace, row=row, col=col)
- def add_contour(
+ def add_cone(
self,
+ anchor=None,
autocolorscale=None,
- autocontour=None,
+ cauto=None,
+ cmax=None,
+ cmid=None,
+ cmin=None,
coloraxis=None,
colorbar=None,
colorscale=None,
- connectgaps=None,
- contours=None,
customdata=None,
customdatasrc=None,
- dx=None,
- dy=None,
- fillcolor=None,
hoverinfo=None,
hoverinfosrc=None,
hoverlabel=None,
- hoverongaps=None,
hovertemplate=None,
hovertemplatesrc=None,
hovertext=None,
@@ -4779,70 +4674,60 @@ def add_contour(
legendgrouptitle=None,
legendrank=None,
legendwidth=None,
- line=None,
+ lighting=None,
+ lightposition=None,
meta=None,
metasrc=None,
name=None,
- ncontours=None,
opacity=None,
reversescale=None,
+ scene=None,
showlegend=None,
showscale=None,
+ sizemode=None,
+ sizeref=None,
stream=None,
text=None,
- textfont=None,
textsrc=None,
- texttemplate=None,
- transpose=None,
+ u=None,
+ uhoverformat=None,
uid=None,
uirevision=None,
+ usrc=None,
+ v=None,
+ vhoverformat=None,
visible=None,
+ vsrc=None,
+ w=None,
+ whoverformat=None,
+ wsrc=None,
x=None,
- x0=None,
- xaxis=None,
- xcalendar=None,
xhoverformat=None,
- xperiod=None,
- xperiod0=None,
- xperiodalignment=None,
xsrc=None,
- xtype=None,
y=None,
- y0=None,
- yaxis=None,
- ycalendar=None,
yhoverformat=None,
- yperiod=None,
- yperiod0=None,
- yperiodalignment=None,
ysrc=None,
- ytype=None,
z=None,
- zauto=None,
zhoverformat=None,
- zmax=None,
- zmid=None,
- zmin=None,
- zorder=None,
zsrc=None,
row=None,
col=None,
- secondary_y=None,
**kwargs,
) -> "Figure":
"""
- Add a new Contour trace
+ Add a new Cone trace
- The data from which contour lines are computed is set in `z`.
- Data in `z` must be a 2D list of numbers. Say that `z` has N
- rows and M columns, then by default, these N rows correspond to
- N y coordinates (set in `y` or auto-generated) and the M
- columns correspond to M x coordinates (set in `x` or auto-
- generated). By setting `transpose` to True, the above behavior
- is flipped.
+ Use cone traces to visualize vector fields. Specify a vector
+ field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and
+ 3 vector component arrays `u`, `v`, `w`. The cones are drawn
+ exactly at the positions given by `x`, `y` and `z`.
Parameters
----------
+ anchor
+ Sets the cones' anchor with respect to their x/y/z
+ positions. Note that "cm" denote the cone's center of
+ mass which corresponds to 1/4 from the tail to tip.
autocolorscale
Determines whether the colorscale is a default palette
(`autocolorscale: true`) or the palette determined by
@@ -4850,11 +4735,24 @@ def add_contour(
`autocolorscale` is true, the default palette will be
chosen according to whether numbers in the `color`
array are all positive, all negative or mixed.
- autocontour
- Determines whether or not the contour level attributes
- are picked by an algorithm. If True, the number of
- contour levels can be set in `ncontours`. If False, set
- the contour level attributes in `contours`.
+ cauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here u/v/w norm) or the
+ bounds set in `cmin` and `cmax` Defaults to `false`
+ when `cmin` and `cmax` are set by the user.
+ cmax
+ Sets the upper bound of the color domain. Value should
+ have the same units as u/v/w norm and if set, `cmin`
+ must be set as well.
+ cmid
+ Sets the mid-point of the color domain by scaling
+ `cmin` and/or `cmax` to be equidistant to this point.
+ Value should have the same units as u/v/w norm. Has no
+ effect when `cauto` is `false`.
+ cmin
+ Sets the lower bound of the color domain. Value should
+ have the same units as u/v/w norm and if set, `cmax`
+ must be set as well.
coloraxis
Sets a reference to a shared color axis. References to
these shared color axes are "coloraxis", "coloraxis2",
@@ -4863,8 +4761,8 @@ def add_contour(
`layout.coloraxis2`, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar
- :class:`plotly.graph_objects.contour.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,
@@ -4872,19 +4770,11 @@ def add_contour(
a mapping for the lowest (0) and highest (1) values are
required. For example, `[[0, 'rgb(0,0,255)'], [1,
'rgb(255,0,0)']]`. To control the bounds of the
- colorscale in color space, use `zmin` and `zmax`.
+ colorscale in color space, use `cmin` and `cmax`.
Alternatively, `colorscale` may be a palette name
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
- connectgaps
- Determines whether or not gaps (i.e. {nan} or missing
- values) in the `z` data are filled in. It is defaulted
- to true if `z` is a one dimensional array otherwise it
- is defaulted to false.
- contours
- :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
@@ -4893,15 +4783,6 @@ def add_contour(
customdatasrc
Sets the source reference on Chart Studio Cloud for
`customdata`.
- dx
- Sets the x coordinate step. See `x0` for more info.
- dy
- Sets the y coordinate step. See `y0` for more info.
- fillcolor
- Sets the fill color if `contours.type` is "constraint".
- Defaults to a half-transparent variant of the line
- color, marker color, or marker line color, whichever is
- available.
hoverinfo
Determines which trace information appear on hover. If
`none` or `skip` are set, no information is displayed
@@ -4911,12 +4792,8 @@ def add_contour(
Sets the source reference on Chart Studio Cloud for
`hoverinfo`.
hoverlabel
- :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
- with them.
+ :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
@@ -4941,8 +4818,9 @@ def add_contour(
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are `arrayOk: true`)
- are available. Anything contained in tag `` is
- displayed in the secondary box, for example
+ are available. Finally, the template string has access
+ to variable `norm` Anything contained in tag ``
+ is displayed in the secondary box, for example
"{fullData.name}". To hide the secondary
box completely, use an empty tag ``.
hovertemplatesrc
@@ -4971,7 +4849,7 @@ def add_contour(
part of the same legend group hide/show at the same
time when toggling legend items.
legendgrouptitle
- :class:`plotly.graph_objects.contour.Legendgrouptitle`
+ :class:`plotly.graph_objects.cone.Legendgrouptitle`
instance or dict with compatible properties
legendrank
Sets the legend rank for this trace. Items and groups
@@ -4987,9 +4865,12 @@ def add_contour(
legendwidth
Sets the width (in px or fraction) of the legend for
this trace.
- line
- :class:`plotly.graph_objects.contour.Line` instance or
+ lighting
+ :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.
@@ -5009,55 +4890,68 @@ def add_contour(
name
Sets the trace name. The trace name appears as the
legend item and on hover.
- ncontours
- Sets the maximum number of contour levels. The actual
- number of contours will be chosen automatically to be
- less than or equal to the value of `ncontours`. Has an
- effect only if `autocontour` is True or if
- `contours.size` is missing.
opacity
- Sets the opacity of the trace.
+ Sets the opacity of the surface. Please note that in
+ the case of using high `opacity` values for example a
+ value greater than or equal to 0.5 on two surfaces (and
+ 0.25 with four surfaces), an overlay of multiple
+ transparent surfaces may not perfectly be sorted in
+ depth by the webgl API. This behavior may be improved
+ in the near future and is subject to change.
reversescale
- Reverses the color mapping if true. If true, `zmin`
+ Reverses the color mapping if true. If true, `cmin`
will correspond to the last color in the array and
- `zmax` will correspond to the first color.
+ `cmax` will correspond to the first color.
+ scene
+ Sets a reference between this trace's 3D coordinate
+ system and a 3D scene. If "scene" (the default value),
+ the (x,y,z) coordinates refer to `layout.scene`. If
+ "scene2", the (x,y,z) coordinates refer to
+ `layout.scene2`, and so on.
showlegend
Determines whether or not an item corresponding to this
trace is shown in the legend.
showscale
Determines whether or not a colorbar is displayed for
this trace.
+ sizemode
+ Determines whether `sizeref` is set as a "scaled" (i.e
+ unitless) scalar (normalized by the max u/v/w norm in
+ the vector field) or as "absolute" value (in the same
+ units as the vector field). To display sizes in actual
+ vector length use "raw".
+ sizeref
+ Adjusts the cone size scaling. The size of the cones is
+ determined by their u/v/w norm multiplied a factor and
+ `sizeref`. This factor (computed internally)
+ corresponds to the minimum "time" to travel across two
+ successive x/y/z positions at the average velocity of
+ those two successive positions. All cones in a given
+ trace use the same factor. With `sizemode` set to
+ "raw", its default value is 1. With `sizemode` set to
+ "scaled", `sizeref` is unitless, its default value is
+ 0.5. With `sizemode` set to "absolute", `sizeref` has
+ the same units as the u/v/w vector field, its the
+ default value is half the sample's maximum vector norm.
stream
- :class:`plotly.graph_objects.contour.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 each z value.
- textfont
- For this trace it only has an effect if `coloring` is
- set to "heatmap". Sets the text font.
+ Sets the text elements associated with the cones. If
+ trace `hoverinfo` contains a "text" flag and
+ "hovertext" is not set, these elements will be seen in
+ the hover labels.
textsrc
Sets the source reference on Chart Studio Cloud for
`text`.
- texttemplate
- For this trace it only has an effect if `coloring` is
- set to "heatmap". Template string used for rendering
- the information text that appear on points. Note that
- this will override `textinfo`. Variables are inserted
- using %{variable}, for example "y: %{y}". Numbers are
- formatted using d3-format's syntax
- %{variable:d3-format}, for example "Price: %{y:$.2f}".
- https://github.com/d3/d3-format/tree/v1.4.5#d3-format
- for details on the formatting syntax. Dates are
- formatted using d3-time-format's syntax
- %{variable|d3-time-format}, for example "Day:
- %{2019-01-01|%A}". https://github.com/d3/d3-time-
- format/tree/v2.2.3#locale_format for details on the
- date formatting syntax. Every attributes that can be
- specified per-point (the ones that are `arrayOk: true`)
- are available. Finally, the template string has access
- to variables `x`, `y`, `z` and `text`.
- transpose
- Transposes the z data.
+ u
+ Sets the x components of the vector field.
+ uhoverformat
+ Sets the hover text formatting rulefor `u` using d3
+ formatting mini-languages which are very similar to
+ those in Python. For numbers, see: https://github.com/d
+ 3/d3-format/tree/v1.4.5#d3-format.By default the values
+ are formatted using generic number format.
uid
Assign an id to this trace, Use this to provide object
constancy between traces during animations and
@@ -5080,24 +4974,39 @@ def add_contour(
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
`uid` that stays with it as it moves.
+ usrc
+ Sets the source reference on Chart Studio Cloud for
+ `u`.
+ v
+ Sets the y components of the vector field.
+ vhoverformat
+ Sets the hover text formatting rulefor `v` using d3
+ formatting mini-languages which are very similar to
+ those in Python. For numbers, see: https://github.com/d
+ 3/d3-format/tree/v1.4.5#d3-format.By default the values
+ are formatted using generic number format.
visible
Determines whether or not this trace is visible. If
"legendonly", the trace is not drawn, but can appear as
a legend item (provided that the legend itself is
visible).
+ vsrc
+ Sets the source reference on Chart Studio Cloud for
+ `v`.
+ w
+ Sets the z components of the vector field.
+ whoverformat
+ Sets the hover text formatting rulefor `w` using d3
+ formatting mini-languages which are very similar to
+ those in Python. For numbers, see: https://github.com/d
+ 3/d3-format/tree/v1.4.5#d3-format.By default the values
+ are formatted using generic number format.
+ wsrc
+ Sets the source reference on Chart Studio Cloud for
+ `w`.
x
- Sets the x coordinates.
- x0
- Alternate to `x`. Builds a linear space of x
- coordinates. Use with `dx` where `x0` is the starting
- coordinate and `dx` the step.
- xaxis
- Sets a reference between this trace's x coordinates and
- a 2D cartesian x axis. If "x" (the default value), the
- x coordinates refer to `layout.xaxis`. If "x2", the x
- coordinates refer to `layout.xaxis2`, and so on.
- xcalendar
- Sets the calendar system to use with `x` date data.
+ Sets the x coordinates of the vector field and of the
+ displayed cones.
xhoverformat
Sets the hover text formatting rulefor `x` using d3
formatting mini-languages which are very similar to
@@ -5111,44 +5020,12 @@ def add_contour(
09:15:23.456* with tickformat "%H~%M~%S.%2f" would
display *09~15~23.46*By default the values are
formatted using `xaxis.hoverformat`.
- xperiod
- Only relevant when the axis `type` is "date". Sets the
- period positioning in milliseconds or "M" on the x
- axis. Special values in the form of "M" could be
- used to declare the number of months. In this case `n`
- must be a positive integer.
- xperiod0
- Only relevant when the axis `type` is "date". Sets the
- base for period positioning in milliseconds or date
- string on the x0 axis. When `x0period` is round number
- of weeks, the `x0period0` by default would be on a
- Sunday i.e. 2000-01-02, otherwise it would be at
- 2000-01-01.
- xperiodalignment
- Only relevant when the axis `type` is "date". Sets the
- alignment of data points on the x axis.
xsrc
Sets the source reference on Chart Studio Cloud for
`x`.
- xtype
- If "array", the heatmap's x coordinates are given by
- "x" (the default behavior when `x` is provided). If
- "scaled", the heatmap's x coordinates are given by "x0"
- and "dx" (the default behavior when `x` is not
- provided).
y
- Sets the y coordinates.
- y0
- Alternate to `y`. Builds a linear space of y
- coordinates. Use with `dy` where `y0` is the starting
- coordinate and `dy` the step.
- yaxis
- Sets a reference between this trace's y coordinates and
- a 2D cartesian y axis. If "y" (the default value), the
- y coordinates refer to `layout.yaxis`. If "y2", the y
- coordinates refer to `layout.yaxis2`, and so on.
- ycalendar
- Sets the calendar system to use with `y` date data.
+ Sets the y coordinates of the vector field and of the
+ displayed cones.
yhoverformat
Sets the hover text formatting rulefor `y` using d3
formatting mini-languages which are very similar to
@@ -5162,62 +5039,25 @@ def add_contour(
09:15:23.456* with tickformat "%H~%M~%S.%2f" would
display *09~15~23.46*By default the values are
formatted using `yaxis.hoverformat`.
- yperiod
- Only relevant when the axis `type` is "date". Sets the
- period positioning in milliseconds or "M" on the y
- axis. Special values in the form of "M" could be
- used to declare the number of months. In this case `n`
- must be a positive integer.
- yperiod0
- Only relevant when the axis `type` is "date". Sets the
- base for period positioning in milliseconds or date
- string on the y0 axis. When `y0period` is round number
- of weeks, the `y0period0` by default would be on a
- Sunday i.e. 2000-01-02, otherwise it would be at
- 2000-01-01.
- yperiodalignment
- Only relevant when the axis `type` is "date". Sets the
- alignment of data points on the y axis.
ysrc
Sets the source reference on Chart Studio Cloud for
`y`.
- ytype
- If "array", the heatmap's y coordinates are given by
- "y" (the default behavior when `y` is provided) If
- "scaled", the heatmap's y coordinates are given by "y0"
- and "dy" (the default behavior when `y` is not
- provided)
z
- Sets the z data.
- zauto
- Determines whether or not the color domain is computed
- with respect to the input data (here in `z`) or the
- bounds set in `zmin` and `zmax` Defaults to `false`
- when `zmin` and `zmax` are set by the user.
+ Sets the z coordinates of the vector field and of the
+ displayed cones.
zhoverformat
Sets the hover text formatting rulefor `z` using d3
formatting mini-languages which are very similar to
- those in Python. For numbers, see: https://github.com/d
- 3/d3-format/tree/v1.4.5#d3-format.By default the values
- are formatted using generic number format.
- zmax
- Sets the upper bound of the color domain. Value should
- have the same units as in `z` and if set, `zmin` must
- be set as well.
- zmid
- Sets the mid-point of the color domain by scaling
- `zmin` and/or `zmax` to be equidistant to this point.
- Value should have the same units as in `z`. Has no
- effect when `zauto` is `false`.
- zmin
- Sets the lower bound of the color domain. Value should
- have the same units as in `z` and if set, `zmax` must
- be set as well.
- zorder
- Sets the layer on which this trace is displayed,
- relative to other SVG traces on the same subplot. SVG
- traces with higher `zorder` appear in front of those
- with lower `zorder`.
+ those in Python. For numbers, see:
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
+ And for dates see: https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format. We add two items to
+ d3's date formatter: "%h" for half of the year as a
+ decimal number as well as "%{n}f" for fractional
+ seconds with n digits. For example, *2016-10-13
+ 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
+ display *09~15~23.46*By default the values are
+ formatted using `zaxis.hoverformat`.
zsrc
Sets the source reference on Chart Studio Cloud for
`z`.
@@ -5231,40 +5071,28 @@ def add_contour(
added. Only valid if figure was created using
`plotly.tools.make_subplots`.If 'all', addresses all
columns in the specified row(s).
- secondary_y: boolean or None (default None)
- If True, associate this trace with the secondary y-axis of the
- subplot at the specified row and col. Only valid if all of the
- following conditions are satisfied:
- * The figure was created using `plotly.subplots.make_subplots`.
- * The row and col arguments are not None
- * The subplot at the specified row and col has type xy
- (which is the default) and secondary_y True. These
- properties are specified in the specs argument to
- make_subplots. See the make_subplots docstring for more info.
Returns
-------
Figure
"""
- from plotly.graph_objs import Contour
+ from plotly.graph_objs import Cone
- new_trace = Contour(
+ new_trace = Cone(
+ anchor=anchor,
autocolorscale=autocolorscale,
- autocontour=autocontour,
+ cauto=cauto,
+ cmax=cmax,
+ cmid=cmid,
+ cmin=cmin,
coloraxis=coloraxis,
colorbar=colorbar,
colorscale=colorscale,
- connectgaps=connectgaps,
- contours=contours,
customdata=customdata,
customdatasrc=customdatasrc,
- dx=dx,
- dy=dy,
- fillcolor=fillcolor,
hoverinfo=hoverinfo,
hoverinfosrc=hoverinfosrc,
hoverlabel=hoverlabel,
- hoverongaps=hoverongaps,
hovertemplate=hovertemplate,
hovertemplatesrc=hovertemplatesrc,
hovertext=hovertext,
@@ -5276,78 +5104,66 @@ def add_contour(
legendgrouptitle=legendgrouptitle,
legendrank=legendrank,
legendwidth=legendwidth,
- line=line,
+ lighting=lighting,
+ lightposition=lightposition,
meta=meta,
metasrc=metasrc,
name=name,
- ncontours=ncontours,
opacity=opacity,
reversescale=reversescale,
+ scene=scene,
showlegend=showlegend,
showscale=showscale,
+ sizemode=sizemode,
+ sizeref=sizeref,
stream=stream,
text=text,
- textfont=textfont,
textsrc=textsrc,
- texttemplate=texttemplate,
- transpose=transpose,
+ u=u,
+ uhoverformat=uhoverformat,
uid=uid,
uirevision=uirevision,
+ usrc=usrc,
+ v=v,
+ vhoverformat=vhoverformat,
visible=visible,
+ vsrc=vsrc,
+ w=w,
+ whoverformat=whoverformat,
+ wsrc=wsrc,
x=x,
- x0=x0,
- xaxis=xaxis,
- xcalendar=xcalendar,
xhoverformat=xhoverformat,
- xperiod=xperiod,
- xperiod0=xperiod0,
- xperiodalignment=xperiodalignment,
xsrc=xsrc,
- xtype=xtype,
y=y,
- y0=y0,
- yaxis=yaxis,
- ycalendar=ycalendar,
yhoverformat=yhoverformat,
- yperiod=yperiod,
- yperiod0=yperiod0,
- yperiodalignment=yperiodalignment,
ysrc=ysrc,
- ytype=ytype,
z=z,
- zauto=zauto,
zhoverformat=zhoverformat,
- zmax=zmax,
- zmid=zmid,
- zmin=zmin,
- zorder=zorder,
zsrc=zsrc,
**kwargs,
)
- return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y)
+ return self.add_trace(new_trace, row=row, col=col)
- def add_contourcarpet(
+ def add_contour(
self,
- a=None,
- a0=None,
- asrc=None,
- atype=None,
autocolorscale=None,
autocontour=None,
- b=None,
- b0=None,
- bsrc=None,
- btype=None,
- carpet=None,
coloraxis=None,
colorbar=None,
colorscale=None,
+ connectgaps=None,
contours=None,
customdata=None,
customdatasrc=None,
- da=None,
- db=None,
+ dx=None,
+ dy=None,
fillcolor=None,
+ hoverinfo=None,
+ hoverinfosrc=None,
+ hoverlabel=None,
+ hoverongaps=None,
+ hovertemplate=None,
+ hovertemplatesrc=None,
hovertext=None,
hovertextsrc=None,
ids=None,
@@ -5368,15 +5184,36 @@ def add_contourcarpet(
showscale=None,
stream=None,
text=None,
+ textfont=None,
textsrc=None,
+ texttemplate=None,
transpose=None,
uid=None,
uirevision=None,
visible=None,
+ x=None,
+ x0=None,
xaxis=None,
+ xcalendar=None,
+ xhoverformat=None,
+ xperiod=None,
+ xperiod0=None,
+ xperiodalignment=None,
+ xsrc=None,
+ xtype=None,
+ y=None,
+ y0=None,
yaxis=None,
+ ycalendar=None,
+ yhoverformat=None,
+ yperiod=None,
+ yperiod0=None,
+ yperiodalignment=None,
+ ysrc=None,
+ ytype=None,
z=None,
zauto=None,
+ zhoverformat=None,
zmax=None,
zmid=None,
zmin=None,
@@ -5388,29 +5225,18 @@ def add_contourcarpet(
**kwargs,
) -> "Figure":
"""
- Add a new Contourcarpet trace
+ Add a new Contour trace
- Plots contours on either the first carpet axis or the carpet
- axis with a matching `carpet` attribute. Data `z` is
- interpreted as matching that of the corresponding carpet axis.
+ The data from which contour lines are computed is set in `z`.
+ Data in `z` must be a 2D list of numbers. Say that `z` has N
+ rows and M columns, then by default, these N rows correspond to
+ N y coordinates (set in `y` or auto-generated) and the M
+ columns correspond to M x coordinates (set in `x` or auto-
+ generated). By setting `transpose` to True, the above behavior
+ is flipped.
Parameters
----------
- a
- Sets the x coordinates.
- a0
- Alternate to `x`. Builds a linear space of x
- coordinates. Use with `dx` where `x0` is the starting
- coordinate and `dx` the step.
- asrc
- Sets the source reference on Chart Studio Cloud for
- `a`.
- atype
- If "array", the heatmap's x coordinates are given by
- "x" (the default behavior when `x` is provided). If
- "scaled", the heatmap's x coordinates are given by "x0"
- and "dx" (the default behavior when `x` is not
- provided).
autocolorscale
Determines whether the colorscale is a default palette
(`autocolorscale: true`) or the palette determined by
@@ -5423,24 +5249,6 @@ def add_contourcarpet(
are picked by an algorithm. If True, the number of
contour levels can be set in `ncontours`. If False, set
the contour level attributes in `contours`.
- b
- Sets the y coordinates.
- b0
- Alternate to `y`. Builds a linear space of y
- coordinates. Use with `dy` where `y0` is the starting
- coordinate and `dy` the step.
- bsrc
- Sets the source reference on Chart Studio Cloud for
- `b`.
- btype
- If "array", the heatmap's y coordinates are given by
- "y" (the default behavior when `y` is provided) If
- "scaled", the heatmap's y coordinates are given by "y0"
- and "dy" (the default behavior when `y` is not
- provided)
- carpet
- The `carpet` of the carpet axes on which this contour
- trace lies
coloraxis
Sets a reference to a shared color axis. References to
these shared color axes are "coloraxis", "coloraxis2",
@@ -5449,8 +5257,8 @@ def add_contourcarpet(
`layout.coloraxis2`, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar
- :class:`plotly.graph_objects.contourcarpet.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,
@@ -5463,9 +5271,14 @@ def add_contourcarpet(
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
+ connectgaps
+ Determines whether or not gaps (i.e. {nan} or missing
+ values) in the `z` data are filled in. It is defaulted
+ to true if `z` is a one dimensional array otherwise it
+ is defaulted to false.
contours
- :class:`plotly.graph_objects.contourcarpet.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
@@ -5474,15 +5287,61 @@ def add_contourcarpet(
customdatasrc
Sets the source reference on Chart Studio Cloud for
`customdata`.
- da
+ dx
Sets the x coordinate step. See `x0` for more info.
- db
+ dy
Sets the y coordinate step. See `y0` for more info.
fillcolor
Sets the fill color if `contours.type` is "constraint".
Defaults to a half-transparent variant of the line
color, marker color, or marker line color, whichever is
available.
+ hoverinfo
+ Determines which trace information appear on hover. If
+ `none` or `skip` are set, no information is displayed
+ upon hovering. But, if `none` is set, click and hover
+ events are still fired.
+ hoverinfosrc
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+ hoverlabel
+ :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
+ with them.
+ hovertemplate
+ Template string used for rendering the information that
+ appear on hover box. Note that this will override
+ `hoverinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}" as well as %{xother}, {%_xother},
+ {%_xother_}, {%xother_}. When showing info for several
+ points, "xother" will be added to those with different
+ x positions from the first point. An underscore before
+ or after "(x|y)other" will add a space on that side,
+ only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for
+ example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. The variables available in
+ `hovertemplate` are the ones emitted as event data
+ described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-
+ data. Additionally, every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Anything contained in tag `` is
+ displayed in the secondary box, for example
+ "{fullData.name}". To hide the secondary
+ box completely, use an empty tag ``.
+ hovertemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
hovertext
Same as `text`.
hovertextsrc
@@ -5506,8 +5365,8 @@ def add_contourcarpet(
part of the same legend group hide/show at the same
time when toggling legend items.
legendgrouptitle
- :class:`plotly.graph_objects.contourcarpet.Legendgroupt
- itle` instance or dict with compatible properties
+ :class:`plotly.graph_objects.contour.Legendgrouptitle`
+ instance or dict with compatible properties
legendrank
Sets the legend rank for this trace. Items and groups
with smaller ranks are presented on top/left side while
@@ -5523,8 +5382,8 @@ def add_contourcarpet(
Sets the width (in px or fraction) of the legend for
this trace.
line
- :class:`plotly.graph_objects.contourcarpet.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.
@@ -5563,13 +5422,34 @@ def add_contourcarpet(
Determines whether or not a colorbar is displayed for
this trace.
stream
- :class:`plotly.graph_objects.contourcarpet.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.
+ textfont
+ For this trace it only has an effect if `coloring` is
+ set to "heatmap". Sets the text font.
textsrc
Sets the source reference on Chart Studio Cloud for
`text`.
+ texttemplate
+ For this trace it only has an effect if `coloring` is
+ set to "heatmap". Template string used for rendering
+ the information text that appear on points. Note that
+ this will override `textinfo`. Variables are inserted
+ using %{variable}, for example "y: %{y}". Numbers are
+ formatted using d3-format's syntax
+ %{variable:d3-format}, for example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. Every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Finally, the template string has access
+ to variables `x`, `y`, `z` and `text`.
transpose
Transposes the z data.
uid
@@ -5599,23 +5479,121 @@ def add_contourcarpet(
"legendonly", the trace is not drawn, but can appear as
a legend item (provided that the legend itself is
visible).
+ x
+ Sets the x coordinates.
+ x0
+ Alternate to `x`. Builds a linear space of x
+ coordinates. Use with `dx` where `x0` is the starting
+ coordinate and `dx` the step.
xaxis
Sets a reference between this trace's x coordinates and
a 2D cartesian x axis. If "x" (the default value), the
x coordinates refer to `layout.xaxis`. If "x2", the x
coordinates refer to `layout.xaxis2`, and so on.
+ xcalendar
+ Sets the calendar system to use with `x` date data.
+ xhoverformat
+ Sets the hover text formatting rulefor `x` using d3
+ formatting mini-languages which are very similar to
+ those in Python. For numbers, see:
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
+ And for dates see: https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format. We add two items to
+ d3's date formatter: "%h" for half of the year as a
+ decimal number as well as "%{n}f" for fractional
+ seconds with n digits. For example, *2016-10-13
+ 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
+ display *09~15~23.46*By default the values are
+ formatted using `xaxis.hoverformat`.
+ xperiod
+ Only relevant when the axis `type` is "date". Sets the
+ period positioning in milliseconds or "M" on the x
+ axis. Special values in the form of "M" could be
+ used to declare the number of months. In this case `n`
+ must be a positive integer.
+ xperiod0
+ Only relevant when the axis `type` is "date". Sets the
+ base for period positioning in milliseconds or date
+ string on the x0 axis. When `x0period` is round number
+ of weeks, the `x0period0` by default would be on a
+ Sunday i.e. 2000-01-02, otherwise it would be at
+ 2000-01-01.
+ xperiodalignment
+ Only relevant when the axis `type` is "date". Sets the
+ alignment of data points on the x axis.
+ xsrc
+ Sets the source reference on Chart Studio Cloud for
+ `x`.
+ xtype
+ If "array", the heatmap's x coordinates are given by
+ "x" (the default behavior when `x` is provided). If
+ "scaled", the heatmap's x coordinates are given by "x0"
+ and "dx" (the default behavior when `x` is not
+ provided).
+ y
+ Sets the y coordinates.
+ y0
+ Alternate to `y`. Builds a linear space of y
+ coordinates. Use with `dy` where `y0` is the starting
+ coordinate and `dy` the step.
yaxis
Sets a reference between this trace's y coordinates and
a 2D cartesian y axis. If "y" (the default value), the
y coordinates refer to `layout.yaxis`. If "y2", the y
coordinates refer to `layout.yaxis2`, and so on.
- z
- Sets the z data.
- zauto
- Determines whether or not the color domain is computed
- with respect to the input data (here in `z`) or the
+ ycalendar
+ Sets the calendar system to use with `y` date data.
+ yhoverformat
+ Sets the hover text formatting rulefor `y` using d3
+ formatting mini-languages which are very similar to
+ those in Python. For numbers, see:
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
+ And for dates see: https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format. We add two items to
+ d3's date formatter: "%h" for half of the year as a
+ decimal number as well as "%{n}f" for fractional
+ seconds with n digits. For example, *2016-10-13
+ 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
+ display *09~15~23.46*By default the values are
+ formatted using `yaxis.hoverformat`.
+ yperiod
+ Only relevant when the axis `type` is "date". Sets the
+ period positioning in milliseconds or "M" on the y
+ axis. Special values in the form of "M" could be
+ used to declare the number of months. In this case `n`
+ must be a positive integer.
+ yperiod0
+ Only relevant when the axis `type` is "date". Sets the
+ base for period positioning in milliseconds or date
+ string on the y0 axis. When `y0period` is round number
+ of weeks, the `y0period0` by default would be on a
+ Sunday i.e. 2000-01-02, otherwise it would be at
+ 2000-01-01.
+ yperiodalignment
+ Only relevant when the axis `type` is "date". Sets the
+ alignment of data points on the y axis.
+ ysrc
+ Sets the source reference on Chart Studio Cloud for
+ `y`.
+ ytype
+ If "array", the heatmap's y coordinates are given by
+ "y" (the default behavior when `y` is provided) If
+ "scaled", the heatmap's y coordinates are given by "y0"
+ and "dy" (the default behavior when `y` is not
+ provided)
+ z
+ Sets the z data.
+ zauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here in `z`) or the
bounds set in `zmin` and `zmax` Defaults to `false`
when `zmin` and `zmax` are set by the user.
+ zhoverformat
+ Sets the hover text formatting rulefor `z` using d3
+ formatting mini-languages which are very similar to
+ those in Python. For numbers, see: https://github.com/d
+ 3/d3-format/tree/v1.4.5#d3-format.By default the values
+ are formatted using generic number format.
zmax
Sets the upper bound of the color domain. Value should
have the same units as in `z` and if set, `zmin` must
@@ -5662,29 +5640,27 @@ def add_contourcarpet(
-------
Figure
"""
- from plotly.graph_objs import Contourcarpet
+ from plotly.graph_objs import Contour
- new_trace = Contourcarpet(
- a=a,
- a0=a0,
- asrc=asrc,
- atype=atype,
+ new_trace = Contour(
autocolorscale=autocolorscale,
autocontour=autocontour,
- b=b,
- b0=b0,
- bsrc=bsrc,
- btype=btype,
- carpet=carpet,
coloraxis=coloraxis,
colorbar=colorbar,
colorscale=colorscale,
+ connectgaps=connectgaps,
contours=contours,
customdata=customdata,
customdatasrc=customdatasrc,
- da=da,
- db=db,
+ dx=dx,
+ dy=dy,
fillcolor=fillcolor,
+ hoverinfo=hoverinfo,
+ hoverinfosrc=hoverinfosrc,
+ hoverlabel=hoverlabel,
+ hoverongaps=hoverongaps,
+ hovertemplate=hovertemplate,
+ hovertemplatesrc=hovertemplatesrc,
hovertext=hovertext,
hovertextsrc=hovertextsrc,
ids=ids,
@@ -5705,15 +5681,36 @@ def add_contourcarpet(
showscale=showscale,
stream=stream,
text=text,
+ textfont=textfont,
textsrc=textsrc,
+ texttemplate=texttemplate,
transpose=transpose,
uid=uid,
uirevision=uirevision,
visible=visible,
+ x=x,
+ x0=x0,
xaxis=xaxis,
+ xcalendar=xcalendar,
+ xhoverformat=xhoverformat,
+ xperiod=xperiod,
+ xperiod0=xperiod0,
+ xperiodalignment=xperiodalignment,
+ xsrc=xsrc,
+ xtype=xtype,
+ y=y,
+ y0=y0,
yaxis=yaxis,
+ ycalendar=ycalendar,
+ yhoverformat=yhoverformat,
+ yperiod=yperiod,
+ yperiod0=yperiod0,
+ yperiodalignment=yperiodalignment,
+ ysrc=ysrc,
+ ytype=ytype,
z=z,
zauto=zauto,
+ zhoverformat=zhoverformat,
zmax=zmax,
zmid=zmid,
zmin=zmin,
@@ -5723,68 +5720,91 @@ def add_contourcarpet(
)
return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y)
- def add_densitymapbox(
+ def add_contourcarpet(
self,
+ a=None,
+ a0=None,
+ asrc=None,
+ atype=None,
autocolorscale=None,
- below=None,
+ autocontour=None,
+ b=None,
+ b0=None,
+ bsrc=None,
+ btype=None,
+ carpet=None,
coloraxis=None,
colorbar=None,
colorscale=None,
+ contours=None,
customdata=None,
customdatasrc=None,
- hoverinfo=None,
- hoverinfosrc=None,
- hoverlabel=None,
- hovertemplate=None,
- hovertemplatesrc=None,
+ da=None,
+ db=None,
+ fillcolor=None,
hovertext=None,
hovertextsrc=None,
ids=None,
idssrc=None,
- lat=None,
- latsrc=None,
legend=None,
legendgroup=None,
legendgrouptitle=None,
legendrank=None,
legendwidth=None,
- lon=None,
- lonsrc=None,
+ line=None,
meta=None,
metasrc=None,
name=None,
+ ncontours=None,
opacity=None,
- radius=None,
- radiussrc=None,
reversescale=None,
showlegend=None,
showscale=None,
stream=None,
- subplot=None,
text=None,
textsrc=None,
+ transpose=None,
uid=None,
uirevision=None,
visible=None,
+ xaxis=None,
+ yaxis=None,
z=None,
zauto=None,
zmax=None,
zmid=None,
zmin=None,
+ zorder=None,
zsrc=None,
row=None,
col=None,
+ secondary_y=None,
**kwargs,
) -> "Figure":
"""
- Add a new Densitymapbox trace
+ Add a new Contourcarpet trace
- Draws a bivariate kernel density estimation with a Gaussian
- kernel from `lon` and `lat` coordinates and optional `z` values
- using a colorscale.
+ Plots contours on either the first carpet axis or the carpet
+ axis with a matching `carpet` attribute. Data `z` is
+ interpreted as matching that of the corresponding carpet axis.
Parameters
----------
+ a
+ Sets the x coordinates.
+ a0
+ Alternate to `x`. Builds a linear space of x
+ coordinates. Use with `dx` where `x0` is the starting
+ coordinate and `dx` the step.
+ asrc
+ Sets the source reference on Chart Studio Cloud for
+ `a`.
+ atype
+ If "array", the heatmap's x coordinates are given by
+ "x" (the default behavior when `x` is provided). If
+ "scaled", the heatmap's x coordinates are given by "x0"
+ and "dx" (the default behavior when `x` is not
+ provided).
autocolorscale
Determines whether the colorscale is a default palette
(`autocolorscale: true`) or the palette determined by
@@ -5792,12 +5812,29 @@ def add_densitymapbox(
`autocolorscale` is true, the default palette will be
chosen according to whether numbers in the `color`
array are all positive, all negative or mixed.
- below
- Determines if the densitymapbox trace will be inserted
- before the layer with the specified ID. By default,
- densitymapbox traces are placed below the first layer
- of type symbol If set to '', the layer will be inserted
- above every existing layer.
+ autocontour
+ Determines whether or not the contour level attributes
+ are picked by an algorithm. If True, the number of
+ contour levels can be set in `ncontours`. If False, set
+ the contour level attributes in `contours`.
+ b
+ Sets the y coordinates.
+ b0
+ Alternate to `y`. Builds a linear space of y
+ coordinates. Use with `dy` where `y0` is the starting
+ coordinate and `dy` the step.
+ bsrc
+ Sets the source reference on Chart Studio Cloud for
+ `b`.
+ btype
+ If "array", the heatmap's y coordinates are given by
+ "y" (the default behavior when `y` is provided) If
+ "scaled", the heatmap's y coordinates are given by "y0"
+ and "dy" (the default behavior when `y` is not
+ provided)
+ carpet
+ The `carpet` of the carpet axes on which this contour
+ trace lies
coloraxis
Sets a reference to a shared color axis. References to
these shared color axes are "coloraxis", "coloraxis2",
@@ -5806,7 +5843,7 @@ def add_densitymapbox(
`layout.coloraxis2`, etc. Note that multiple color
scales can be linked to the same color axis.
colorbar
- :class:`plotly.graph_objects.densitymapbox.ColorBar`
+ :class:`plotly.graph_objects.contourcarpet.ColorBar`
instance or dict with compatible properties
colorscale
Sets the colorscale. The colorscale must be an array
@@ -5820,6 +5857,9 @@ def add_densitymapbox(
string of the following list: Blackbody,Bluered,Blues,C
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
+ contours
+ :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
@@ -5828,55 +5868,17 @@ def add_densitymapbox(
customdatasrc
Sets the source reference on Chart Studio Cloud for
`customdata`.
- hoverinfo
- Determines which trace information appear on hover. If
- `none` or `skip` are set, no information is displayed
- upon hovering. But, if `none` is set, click and hover
- events are still fired.
- hoverinfosrc
- Sets the source reference on Chart Studio Cloud for
- `hoverinfo`.
- hoverlabel
- :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
- `hoverinfo`. Variables are inserted using %{variable},
- for example "y: %{y}" as well as %{xother}, {%_xother},
- {%_xother_}, {%xother_}. When showing info for several
- points, "xother" will be added to those with different
- x positions from the first point. An underscore before
- or after "(x|y)other" will add a space on that side,
- only when this field is shown. Numbers are formatted
- using d3-format's syntax %{variable:d3-format}, for
- example "Price: %{y:$.2f}".
- https://github.com/d3/d3-format/tree/v1.4.5#d3-format
- for details on the formatting syntax. Dates are
- formatted using d3-time-format's syntax
- %{variable|d3-time-format}, for example "Day:
- %{2019-01-01|%A}". https://github.com/d3/d3-time-
- format/tree/v2.2.3#locale_format for details on the
- date formatting syntax. The variables available in
- `hovertemplate` are the ones emitted as event data
- described at this link
- https://plotly.com/javascript/plotlyjs-events/#event-
- data. Additionally, every attributes that can be
- specified per-point (the ones that are `arrayOk: true`)
- are available. Anything contained in tag `` is
- displayed in the secondary box, for example
- "{fullData.name}". To hide the secondary
- box completely, use an empty tag ``.
- hovertemplatesrc
- Sets the source reference on Chart Studio Cloud for
- `hovertemplate`.
+ da
+ Sets the x coordinate step. See `x0` for more info.
+ db
+ Sets the y coordinate step. See `y0` for more info.
+ fillcolor
+ Sets the fill color if `contours.type` is "constraint".
+ Defaults to a half-transparent variant of the line
+ color, marker color, or marker line color, whichever is
+ available.
hovertext
- Sets hover text elements associated with each (lon,lat)
- pair If a single string, the same string appears over
- all the data points. If an array of string, the items
- are mapped in order to the this trace's (lon,lat)
- coordinates. To be seen, trace `hoverinfo` must contain
- a "text" flag.
+ Same as `text`.
hovertextsrc
Sets the source reference on Chart Studio Cloud for
`hovertext`.
@@ -5887,11 +5889,6 @@ def add_densitymapbox(
idssrc
Sets the source reference on Chart Studio Cloud for
`ids`.
- lat
- Sets the latitude coordinates (in degrees North).
- latsrc
- Sets the source reference on Chart Studio Cloud for
- `lat`.
legend
Sets the reference to a legend to show this trace in.
References to these legends are "legend", "legend2",
@@ -5903,7 +5900,7 @@ def add_densitymapbox(
part of the same legend group hide/show at the same
time when toggling legend items.
legendgrouptitle
- :class:`plotly.graph_objects.densitymapbox.Legendgroupt
+ :class:`plotly.graph_objects.contourcarpet.Legendgroupt
itle` instance or dict with compatible properties
legendrank
Sets the legend rank for this trace. Items and groups
@@ -5919,11 +5916,9 @@ def add_densitymapbox(
legendwidth
Sets the width (in px or fraction) of the legend for
this trace.
- lon
- Sets the longitude coordinates (in degrees East).
- lonsrc
- Sets the source reference on Chart Studio Cloud for
- `lon`.
+ line
+ :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.
@@ -5943,15 +5938,14 @@ def add_densitymapbox(
name
Sets the trace name. The trace name appears as the
legend item and on hover.
+ ncontours
+ Sets the maximum number of contour levels. The actual
+ number of contours will be chosen automatically to be
+ less than or equal to the value of `ncontours`. Has an
+ effect only if `autocontour` is True or if
+ `contours.size` is missing.
opacity
Sets the opacity of the trace.
- radius
- Sets the radius of influence of one `lon` / `lat` point
- in pixels. Increasing the value makes the densitymapbox
- trace smoother, but less detailed.
- radiussrc
- Sets the source reference on Chart Studio Cloud for
- `radius`.
reversescale
Reverses the color mapping if true. If true, `zmin`
will correspond to the last color in the array and
@@ -5963,24 +5957,15 @@ def add_densitymapbox(
Determines whether or not a colorbar is displayed for
this trace.
stream
- :class:`plotly.graph_objects.densitymapbox.Stream`
+ :class:`plotly.graph_objects.contourcarpet.Stream`
instance or dict with compatible properties
- subplot
- Sets a reference between this trace's data coordinates
- and a mapbox subplot. If "mapbox" (the default value),
- the data refer to `layout.mapbox`. If "mapbox2", the
- data refer to `layout.mapbox2`, and so on.
text
- Sets text elements associated with each (lon,lat) pair
- If a single string, the same string appears over all
- the data points. If an array of string, the items are
- mapped in order to the this trace's (lon,lat)
- coordinates. If trace `hoverinfo` contains a "text"
- flag and "hovertext" is not set, these elements will be
- seen in the hover labels.
+ Sets the text elements associated with each z value.
textsrc
Sets the source reference on Chart Studio Cloud for
`text`.
+ transpose
+ Transposes the z data.
uid
Assign an id to this trace, Use this to provide object
constancy between traces during animations and
@@ -6008,10 +5993,18 @@ def add_densitymapbox(
"legendonly", the trace is not drawn, but can appear as
a legend item (provided that the legend itself is
visible).
+ xaxis
+ Sets a reference between this trace's x coordinates and
+ a 2D cartesian x axis. If "x" (the default value), the
+ x coordinates refer to `layout.xaxis`. If "x2", the x
+ coordinates refer to `layout.xaxis2`, and so on.
+ yaxis
+ Sets a reference between this trace's y coordinates and
+ a 2D cartesian y axis. If "y" (the default value), the
+ y coordinates refer to `layout.yaxis`. If "y2", the y
+ coordinates refer to `layout.yaxis2`, and so on.
z
- Sets the points' weight. For example, a value of 10
- would be equivalent to having 10 points of weight 1 in
- the same spot
+ Sets the z data.
zauto
Determines whether or not the color domain is computed
with respect to the input data (here in `z`) or the
@@ -6030,6 +6023,11 @@ def add_densitymapbox(
Sets the lower bound of the color domain. Value should
have the same units as in `z` and if set, `zmax` must
be set as well.
+ zorder
+ Sets the layer on which this trace is displayed,
+ relative to other SVG traces on the same subplot. SVG
+ traces with higher `zorder` appear in front of those
+ with lower `zorder`.
zsrc
Sets the source reference on Chart Studio Cloud for
`z`.
@@ -6043,75 +6041,91 @@ def add_densitymapbox(
added. Only valid if figure was created using
`plotly.tools.make_subplots`.If 'all', addresses all
columns in the specified row(s).
+ secondary_y: boolean or None (default None)
+ If True, associate this trace with the secondary y-axis of the
+ subplot at the specified row and col. Only valid if all of the
+ following conditions are satisfied:
+ * The figure was created using `plotly.subplots.make_subplots`.
+ * The row and col arguments are not None
+ * The subplot at the specified row and col has type xy
+ (which is the default) and secondary_y True. These
+ properties are specified in the specs argument to
+ make_subplots. See the make_subplots docstring for more info.
Returns
-------
Figure
"""
- from plotly.graph_objs import Densitymapbox
+ from plotly.graph_objs import Contourcarpet
- new_trace = Densitymapbox(
+ new_trace = Contourcarpet(
+ a=a,
+ a0=a0,
+ asrc=asrc,
+ atype=atype,
autocolorscale=autocolorscale,
- below=below,
+ autocontour=autocontour,
+ b=b,
+ b0=b0,
+ bsrc=bsrc,
+ btype=btype,
+ carpet=carpet,
coloraxis=coloraxis,
colorbar=colorbar,
colorscale=colorscale,
+ contours=contours,
customdata=customdata,
customdatasrc=customdatasrc,
- hoverinfo=hoverinfo,
- hoverinfosrc=hoverinfosrc,
- hoverlabel=hoverlabel,
- hovertemplate=hovertemplate,
- hovertemplatesrc=hovertemplatesrc,
+ da=da,
+ db=db,
+ fillcolor=fillcolor,
hovertext=hovertext,
hovertextsrc=hovertextsrc,
ids=ids,
idssrc=idssrc,
- lat=lat,
- latsrc=latsrc,
legend=legend,
legendgroup=legendgroup,
legendgrouptitle=legendgrouptitle,
legendrank=legendrank,
legendwidth=legendwidth,
- lon=lon,
- lonsrc=lonsrc,
+ line=line,
meta=meta,
metasrc=metasrc,
name=name,
+ ncontours=ncontours,
opacity=opacity,
- radius=radius,
- radiussrc=radiussrc,
reversescale=reversescale,
showlegend=showlegend,
showscale=showscale,
stream=stream,
- subplot=subplot,
text=text,
textsrc=textsrc,
+ transpose=transpose,
uid=uid,
uirevision=uirevision,
visible=visible,
+ xaxis=xaxis,
+ yaxis=yaxis,
z=z,
zauto=zauto,
zmax=zmax,
zmid=zmid,
zmin=zmin,
+ zorder=zorder,
zsrc=zsrc,
**kwargs,
)
- return self.add_trace(new_trace, row=row, col=col)
+ return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y)
- def add_funnel(
+ def add_densitymap(
self,
- alignmentgroup=None,
- cliponaxis=None,
- connector=None,
- constraintext=None,
+ autocolorscale=None,
+ below=None,
+ coloraxis=None,
+ colorbar=None,
+ colorscale=None,
customdata=None,
customdatasrc=None,
- dx=None,
- dy=None,
hoverinfo=None,
hoverinfosrc=None,
hoverlabel=None,
@@ -6121,88 +6135,85 @@ def add_funnel(
hovertextsrc=None,
ids=None,
idssrc=None,
- insidetextanchor=None,
- insidetextfont=None,
+ lat=None,
+ latsrc=None,
legend=None,
legendgroup=None,
legendgrouptitle=None,
legendrank=None,
legendwidth=None,
- marker=None,
+ lon=None,
+ lonsrc=None,
meta=None,
metasrc=None,
name=None,
- offset=None,
- offsetgroup=None,
opacity=None,
- orientation=None,
- outsidetextfont=None,
- selectedpoints=None,
+ radius=None,
+ radiussrc=None,
+ reversescale=None,
showlegend=None,
+ showscale=None,
stream=None,
+ subplot=None,
text=None,
- textangle=None,
- textfont=None,
- textinfo=None,
- textposition=None,
- textpositionsrc=None,
textsrc=None,
- texttemplate=None,
- texttemplatesrc=None,
uid=None,
uirevision=None,
visible=None,
- width=None,
- x=None,
- x0=None,
- xaxis=None,
- xhoverformat=None,
- xperiod=None,
- xperiod0=None,
- xperiodalignment=None,
- xsrc=None,
- y=None,
- y0=None,
- yaxis=None,
- yhoverformat=None,
- yperiod=None,
- yperiod0=None,
- yperiodalignment=None,
- ysrc=None,
- zorder=None,
+ z=None,
+ zauto=None,
+ zmax=None,
+ zmid=None,
+ zmin=None,
+ zsrc=None,
row=None,
col=None,
- secondary_y=None,
**kwargs,
) -> "Figure":
"""
- Add a new Funnel trace
+ Add a new Densitymap trace
- Visualize stages in a process using length-encoded bars. This
- trace can be used to show data in either a part-to-whole
- representation wherein each item appears in a single stage, or
- in a "drop-off" representation wherein each item appears in
- each stage it traversed. See also the "funnelarea" trace type
- for a different approach to visualizing funnel data.
+ Draws a bivariate kernel density estimation with a Gaussian
+ kernel from `lon` and `lat` coordinates and optional `z` values
+ using a colorscale.
Parameters
----------
- alignmentgroup
- Set several traces linked to the same position axis or
- matching axes to the same alignmentgroup. This controls
- whether bars compute their positional range dependently
- or independently.
- cliponaxis
- Determines whether the text nodes are clipped about the
- subplot axes. To show the text nodes above axis lines
- and tick labels, make sure to set `xaxis.layer` and
- `yaxis.layer` to *below traces*.
- connector
- :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.
+ autocolorscale
+ Determines whether the colorscale is a default palette
+ (`autocolorscale: true`) or the palette determined by
+ `colorscale`. In case `colorscale` is unspecified or
+ `autocolorscale` is true, the default palette will be
+ chosen according to whether numbers in the `color`
+ array are all positive, all negative or mixed.
+ below
+ Determines if the densitymap trace will be inserted
+ before the layer with the specified ID. By default,
+ densitymap traces are placed below the first layer of
+ type symbol If set to '', the layer will be inserted
+ above every existing layer.
+ coloraxis
+ Sets a reference to a shared color axis. References to
+ these shared color axes are "coloraxis", "coloraxis2",
+ "coloraxis3", etc. Settings for these shared color axes
+ are set in the layout, under `layout.coloraxis`,
+ `layout.coloraxis2`, etc. Note that multiple color
+ scales can be linked to the same color axis.
+ colorbar
+ :class:`plotly.graph_objects.densitymap.ColorBar`
+ instance or dict with compatible properties
+ colorscale
+ Sets the colorscale. The colorscale must be an array
+ containing arrays mapping a normalized value to an rgb,
+ rgba, hex, hsl, hsv, or named color string. At minimum,
+ a mapping for the lowest (0) and highest (1) values are
+ required. For example, `[[0, 'rgb(0,0,255)'], [1,
+ 'rgb(255,0,0)']]`. To control the bounds of the
+ colorscale in color space, use `zmin` and `zmax`.
+ Alternatively, `colorscale` may be a palette name
+ string of the following list: Blackbody,Bluered,Blues,C
+ ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
+ and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
customdata
Assigns extra data each datum. This may be useful when
listening to hover, click and selection events. Note
@@ -6211,10 +6222,6 @@ def add_funnel(
customdatasrc
Sets the source reference on Chart Studio Cloud for
`customdata`.
- dx
- Sets the x coordinate step. See `x0` for more info.
- dy
- Sets the y coordinate step. See `y0` for more info.
hoverinfo
Determines which trace information appear on hover. If
`none` or `skip` are set, no information is displayed
@@ -6224,7 +6231,7 @@ def add_funnel(
Sets the source reference on Chart Studio Cloud for
`hoverinfo`.
hoverlabel
- :class:`plotly.graph_objects.funnel.Hoverlabel`
+ :class:`plotly.graph_objects.densitymap.Hoverlabel`
instance or dict with compatible properties
hovertemplate
Template string used for rendering the information that
@@ -6250,9 +6257,7 @@ def add_funnel(
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are `arrayOk: true`)
- are available. Finally, the template string has access
- to variables `percentInitial`, `percentPrevious` and
- `percentTotal`. Anything contained in tag `` is
+ are available. Anything contained in tag `` is
displayed in the secondary box, for example
"{fullData.name}". To hide the secondary
box completely, use an empty tag ``.
@@ -6260,10 +6265,10 @@ def add_funnel(
Sets the source reference on Chart Studio Cloud for
`hovertemplate`.
hovertext
- Sets hover text elements associated with each (x,y)
- pair. If a single string, the same string appears over
+ Sets hover text elements associated with each (lon,lat)
+ pair If a single string, the same string appears over
all the data points. If an array of string, the items
- are mapped in order to the this trace's (x,y)
+ are mapped in order to the this trace's (lon,lat)
coordinates. To be seen, trace `hoverinfo` must contain
a "text" flag.
hovertextsrc
@@ -6276,11 +6281,11 @@ def add_funnel(
idssrc
Sets the source reference on Chart Studio Cloud for
`ids`.
- insidetextanchor
- Determines if texts are kept at center or start/end
- points in `textposition` "inside" mode.
- insidetextfont
- Sets the font used for `text` lying inside the bar.
+ lat
+ Sets the latitude coordinates (in degrees North).
+ latsrc
+ Sets the source reference on Chart Studio Cloud for
+ `lat`.
legend
Sets the reference to a legend to show this trace in.
References to these legends are "legend", "legend2",
@@ -6292,8 +6297,8 @@ def add_funnel(
part of the same legend group hide/show at the same
time when toggling legend items.
legendgrouptitle
- :class:`plotly.graph_objects.funnel.Legendgrouptitle`
- instance or dict with compatible properties
+ :class:`plotly.graph_objects.densitymap.Legendgrouptitl
+ e` instance or dict with compatible properties
legendrank
Sets the legend rank for this trace. Items and groups
with smaller ranks are presented on top/left side while
@@ -6308,9 +6313,11 @@ def add_funnel(
legendwidth
Sets the width (in px or fraction) of the legend for
this trace.
- marker
- :class:`plotly.graph_objects.funnel.Marker` instance or
- dict with compatible properties
+ lon
+ Sets the longitude coordinates (in degrees East).
+ lonsrc
+ Sets the source reference on Chart Studio Cloud for
+ `lon`.
meta
Assigns extra meta information associated with this
trace that can be used in various text attributes.
@@ -6330,7 +6337,780 @@ def add_funnel(
name
Sets the trace name. The trace name appears as the
legend item and on hover.
- offset
+ opacity
+ Sets the opacity of the trace.
+ radius
+ Sets the radius of influence of one `lon` / `lat` point
+ in pixels. Increasing the value makes the densitymap
+ trace smoother, but less detailed.
+ radiussrc
+ Sets the source reference on Chart Studio Cloud for
+ `radius`.
+ reversescale
+ Reverses the color mapping if true. If true, `zmin`
+ will correspond to the last color in the array and
+ `zmax` will correspond to the first color.
+ showlegend
+ Determines whether or not an item corresponding to this
+ trace is shown in the legend.
+ showscale
+ Determines whether or not a colorbar is displayed for
+ this trace.
+ stream
+ :class:`plotly.graph_objects.densitymap.Stream`
+ instance or dict with compatible properties
+ subplot
+ Sets a reference between this trace's data coordinates
+ and a map subplot. If "map" (the default value), the
+ data refer to `layout.map`. If "map2", the data refer
+ to `layout.map2`, and so on.
+ text
+ Sets text elements associated with each (lon,lat) pair
+ If a single string, the same string appears over all
+ the data points. If an array of string, the items are
+ mapped in order to the this trace's (lon,lat)
+ coordinates. If trace `hoverinfo` contains a "text"
+ flag and "hovertext" is not set, these elements will be
+ seen in the hover labels.
+ textsrc
+ Sets the source reference on Chart Studio Cloud for
+ `text`.
+ uid
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and
+ transitions.
+ uirevision
+ Controls persistence of some user-driven changes to the
+ trace: `constraintrange` in `parcoords` traces, as well
+ as some `editable: true` modifications such as `name`
+ and `colorbar.title`. Defaults to `layout.uirevision`.
+ Note that other user-driven trace attribute changes are
+ controlled by `layout` attributes: `trace.visible` is
+ controlled by `layout.legend.uirevision`,
+ `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)`
+ (accessible with `config: {editable: true}`) is
+ controlled by `layout.editrevision`. Trace changes are
+ tracked by `uid`, which only falls back on trace index
+ if no `uid` is provided. So if your app can add/remove
+ traces before the end of the `data` array, such that
+ the same trace has a different index, you can still
+ preserve user-driven changes if you give each trace a
+ `uid` that stays with it as it moves.
+ visible
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as
+ a legend item (provided that the legend itself is
+ visible).
+ z
+ Sets the points' weight. For example, a value of 10
+ would be equivalent to having 10 points of weight 1 in
+ the same spot
+ zauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here in `z`) or the
+ bounds set in `zmin` and `zmax` Defaults to `false`
+ when `zmin` and `zmax` are set by the user.
+ zmax
+ Sets the upper bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmin` must
+ be set as well.
+ zmid
+ Sets the mid-point of the color domain by scaling
+ `zmin` and/or `zmax` to be equidistant to this point.
+ Value should have the same units as in `z`. Has no
+ effect when `zauto` is `false`.
+ zmin
+ Sets the lower bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmax` must
+ be set as well.
+ zsrc
+ Sets the source reference on Chart Studio Cloud for
+ `z`.
+ row : 'all', int or None (default)
+ Subplot row index (starting from 1) for the trace to be
+ added. Only valid if figure was created using
+ `plotly.tools.make_subplots`.If 'all', addresses all
+ rows in the specified column(s).
+ col : 'all', int or None (default)
+ Subplot col index (starting from 1) for the trace to be
+ added. Only valid if figure was created using
+ `plotly.tools.make_subplots`.If 'all', addresses all
+ columns in the specified row(s).
+
+ Returns
+ -------
+ Figure
+ """
+ from plotly.graph_objs import Densitymap
+
+ new_trace = Densitymap(
+ autocolorscale=autocolorscale,
+ below=below,
+ coloraxis=coloraxis,
+ colorbar=colorbar,
+ colorscale=colorscale,
+ customdata=customdata,
+ customdatasrc=customdatasrc,
+ hoverinfo=hoverinfo,
+ hoverinfosrc=hoverinfosrc,
+ hoverlabel=hoverlabel,
+ hovertemplate=hovertemplate,
+ hovertemplatesrc=hovertemplatesrc,
+ hovertext=hovertext,
+ hovertextsrc=hovertextsrc,
+ ids=ids,
+ idssrc=idssrc,
+ lat=lat,
+ latsrc=latsrc,
+ legend=legend,
+ legendgroup=legendgroup,
+ legendgrouptitle=legendgrouptitle,
+ legendrank=legendrank,
+ legendwidth=legendwidth,
+ lon=lon,
+ lonsrc=lonsrc,
+ meta=meta,
+ metasrc=metasrc,
+ name=name,
+ opacity=opacity,
+ radius=radius,
+ radiussrc=radiussrc,
+ reversescale=reversescale,
+ showlegend=showlegend,
+ showscale=showscale,
+ stream=stream,
+ subplot=subplot,
+ text=text,
+ textsrc=textsrc,
+ uid=uid,
+ uirevision=uirevision,
+ visible=visible,
+ z=z,
+ zauto=zauto,
+ zmax=zmax,
+ zmid=zmid,
+ zmin=zmin,
+ zsrc=zsrc,
+ **kwargs,
+ )
+ return self.add_trace(new_trace, row=row, col=col)
+
+ def add_densitymapbox(
+ self,
+ autocolorscale=None,
+ below=None,
+ coloraxis=None,
+ colorbar=None,
+ colorscale=None,
+ customdata=None,
+ customdatasrc=None,
+ hoverinfo=None,
+ hoverinfosrc=None,
+ hoverlabel=None,
+ hovertemplate=None,
+ hovertemplatesrc=None,
+ hovertext=None,
+ hovertextsrc=None,
+ ids=None,
+ idssrc=None,
+ lat=None,
+ latsrc=None,
+ legend=None,
+ legendgroup=None,
+ legendgrouptitle=None,
+ legendrank=None,
+ legendwidth=None,
+ lon=None,
+ lonsrc=None,
+ meta=None,
+ metasrc=None,
+ name=None,
+ opacity=None,
+ radius=None,
+ radiussrc=None,
+ reversescale=None,
+ showlegend=None,
+ showscale=None,
+ stream=None,
+ subplot=None,
+ text=None,
+ textsrc=None,
+ uid=None,
+ uirevision=None,
+ visible=None,
+ z=None,
+ zauto=None,
+ zmax=None,
+ zmid=None,
+ zmin=None,
+ zsrc=None,
+ row=None,
+ col=None,
+ **kwargs,
+ ) -> "Figure":
+ """
+ Add a new Densitymapbox trace
+
+ "densitymapbox" trace is deprecated! Please consider switching
+ to the "densitymap" trace type and `map` subplots. Learn more
+ at: https://plotly.com/javascript/maplibre-migration/ Draws a
+ bivariate kernel density estimation with a Gaussian kernel from
+ `lon` and `lat` coordinates and optional `z` values using a
+ colorscale.
+
+ Parameters
+ ----------
+ autocolorscale
+ Determines whether the colorscale is a default palette
+ (`autocolorscale: true`) or the palette determined by
+ `colorscale`. In case `colorscale` is unspecified or
+ `autocolorscale` is true, the default palette will be
+ chosen according to whether numbers in the `color`
+ array are all positive, all negative or mixed.
+ below
+ Determines if the densitymapbox trace will be inserted
+ before the layer with the specified ID. By default,
+ densitymapbox traces are placed below the first layer
+ of type symbol If set to '', the layer will be inserted
+ above every existing layer.
+ coloraxis
+ Sets a reference to a shared color axis. References to
+ these shared color axes are "coloraxis", "coloraxis2",
+ "coloraxis3", etc. Settings for these shared color axes
+ are set in the layout, under `layout.coloraxis`,
+ `layout.coloraxis2`, etc. Note that multiple color
+ scales can be linked to the same color axis.
+ colorbar
+ :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,
+ rgba, hex, hsl, hsv, or named color string. At minimum,
+ a mapping for the lowest (0) and highest (1) values are
+ required. For example, `[[0, 'rgb(0,0,255)'], [1,
+ 'rgb(255,0,0)']]`. To control the bounds of the
+ colorscale in color space, use `zmin` and `zmax`.
+ Alternatively, `colorscale` may be a palette name
+ string of the following list: Blackbody,Bluered,Blues,C
+ ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
+ and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
+ customdata
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note
+ that, "scatter" traces also appends customdata items in
+ the markers DOM elements
+ customdatasrc
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+ hoverinfo
+ Determines which trace information appear on hover. If
+ `none` or `skip` are set, no information is displayed
+ upon hovering. But, if `none` is set, click and hover
+ events are still fired.
+ hoverinfosrc
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+ hoverlabel
+ :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
+ `hoverinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}" as well as %{xother}, {%_xother},
+ {%_xother_}, {%xother_}. When showing info for several
+ points, "xother" will be added to those with different
+ x positions from the first point. An underscore before
+ or after "(x|y)other" will add a space on that side,
+ only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for
+ example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. The variables available in
+ `hovertemplate` are the ones emitted as event data
+ described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-
+ data. Additionally, every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Anything contained in tag `` is
+ displayed in the secondary box, for example
+ "{fullData.name}". To hide the secondary
+ box completely, use an empty tag ``.
+ hovertemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+ hovertext
+ Sets hover text elements associated with each (lon,lat)
+ pair If a single string, the same string appears over
+ all the data points. If an array of string, the items
+ are mapped in order to the this trace's (lon,lat)
+ coordinates. To be seen, trace `hoverinfo` must contain
+ a "text" flag.
+ hovertextsrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
+ ids
+ Assigns id labels to each datum. These ids for object
+ constancy of data points during animation. Should be an
+ array of strings, not numbers or any other type.
+ idssrc
+ Sets the source reference on Chart Studio Cloud for
+ `ids`.
+ lat
+ Sets the latitude coordinates (in degrees North).
+ latsrc
+ Sets the source reference on Chart Studio Cloud for
+ `lat`.
+ legend
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2",
+ "legend3", etc. Settings for these legends are set in
+ the layout, under `layout.legend`, `layout.legend2`,
+ etc.
+ legendgroup
+ Sets the legend group for this trace. Traces and shapes
+ part of the same legend group hide/show at the same
+ time when toggling legend items.
+ legendgrouptitle
+ :class:`plotly.graph_objects.densitymapbox.Legendgroupt
+ itle` instance or dict with compatible properties
+ legendrank
+ Sets the legend rank for this trace. Items and groups
+ with smaller ranks are presented on top/left side while
+ with "reversed" `legend.traceorder` they are on
+ bottom/right side. The default legendrank is 1000, so
+ that you can use ranks less than 1000 to place certain
+ items before all unranked items, and ranks greater than
+ 1000 to go after all unranked items. When having
+ unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and
+ layout.
+ legendwidth
+ Sets the width (in px or fraction) of the legend for
+ this trace.
+ lon
+ Sets the longitude coordinates (in degrees East).
+ lonsrc
+ Sets the source reference on Chart Studio Cloud for
+ `lon`.
+ meta
+ Assigns extra meta information associated with this
+ trace that can be used in various text attributes.
+ Attributes such as trace `name`, graph, axis and
+ colorbar `title.text`, annotation `text`
+ `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta`
+ values in an attribute in the same trace, simply use
+ `%{meta[i]}` where `i` is the index or key of the
+ `meta` item in question. To access trace `meta` in
+ layout attributes, use `%{data[n[.meta[i]}` where `i`
+ is the index or key of the `meta` and `n` is the trace
+ index.
+ metasrc
+ Sets the source reference on Chart Studio Cloud for
+ `meta`.
+ name
+ Sets the trace name. The trace name appears as the
+ legend item and on hover.
+ opacity
+ Sets the opacity of the trace.
+ radius
+ Sets the radius of influence of one `lon` / `lat` point
+ in pixels. Increasing the value makes the densitymapbox
+ trace smoother, but less detailed.
+ radiussrc
+ Sets the source reference on Chart Studio Cloud for
+ `radius`.
+ reversescale
+ Reverses the color mapping if true. If true, `zmin`
+ will correspond to the last color in the array and
+ `zmax` will correspond to the first color.
+ showlegend
+ Determines whether or not an item corresponding to this
+ trace is shown in the legend.
+ showscale
+ Determines whether or not a colorbar is displayed for
+ this trace.
+ stream
+ :class:`plotly.graph_objects.densitymapbox.Stream`
+ instance or dict with compatible properties
+ subplot
+ mapbox subplots and traces are deprecated! Please
+ consider switching to `map` subplots and traces. Learn
+ more at: https://plotly.com/javascript/maplibre-
+ migration/ Sets a reference between this trace's data
+ coordinates and a mapbox subplot. If "mapbox" (the
+ default value), the data refer to `layout.mapbox`. If
+ "mapbox2", the data refer to `layout.mapbox2`, and so
+ on.
+ text
+ Sets text elements associated with each (lon,lat) pair
+ If a single string, the same string appears over all
+ the data points. If an array of string, the items are
+ mapped in order to the this trace's (lon,lat)
+ coordinates. If trace `hoverinfo` contains a "text"
+ flag and "hovertext" is not set, these elements will be
+ seen in the hover labels.
+ textsrc
+ Sets the source reference on Chart Studio Cloud for
+ `text`.
+ uid
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and
+ transitions.
+ uirevision
+ Controls persistence of some user-driven changes to the
+ trace: `constraintrange` in `parcoords` traces, as well
+ as some `editable: true` modifications such as `name`
+ and `colorbar.title`. Defaults to `layout.uirevision`.
+ Note that other user-driven trace attribute changes are
+ controlled by `layout` attributes: `trace.visible` is
+ controlled by `layout.legend.uirevision`,
+ `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)`
+ (accessible with `config: {editable: true}`) is
+ controlled by `layout.editrevision`. Trace changes are
+ tracked by `uid`, which only falls back on trace index
+ if no `uid` is provided. So if your app can add/remove
+ traces before the end of the `data` array, such that
+ the same trace has a different index, you can still
+ preserve user-driven changes if you give each trace a
+ `uid` that stays with it as it moves.
+ visible
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as
+ a legend item (provided that the legend itself is
+ visible).
+ z
+ Sets the points' weight. For example, a value of 10
+ would be equivalent to having 10 points of weight 1 in
+ the same spot
+ zauto
+ Determines whether or not the color domain is computed
+ with respect to the input data (here in `z`) or the
+ bounds set in `zmin` and `zmax` Defaults to `false`
+ when `zmin` and `zmax` are set by the user.
+ zmax
+ Sets the upper bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmin` must
+ be set as well.
+ zmid
+ Sets the mid-point of the color domain by scaling
+ `zmin` and/or `zmax` to be equidistant to this point.
+ Value should have the same units as in `z`. Has no
+ effect when `zauto` is `false`.
+ zmin
+ Sets the lower bound of the color domain. Value should
+ have the same units as in `z` and if set, `zmax` must
+ be set as well.
+ zsrc
+ Sets the source reference on Chart Studio Cloud for
+ `z`.
+ row : 'all', int or None (default)
+ Subplot row index (starting from 1) for the trace to be
+ added. Only valid if figure was created using
+ `plotly.tools.make_subplots`.If 'all', addresses all
+ rows in the specified column(s).
+ col : 'all', int or None (default)
+ Subplot col index (starting from 1) for the trace to be
+ added. Only valid if figure was created using
+ `plotly.tools.make_subplots`.If 'all', addresses all
+ columns in the specified row(s).
+
+ Returns
+ -------
+ Figure
+ """
+ from plotly.graph_objs import Densitymapbox
+
+ new_trace = Densitymapbox(
+ autocolorscale=autocolorscale,
+ below=below,
+ coloraxis=coloraxis,
+ colorbar=colorbar,
+ colorscale=colorscale,
+ customdata=customdata,
+ customdatasrc=customdatasrc,
+ hoverinfo=hoverinfo,
+ hoverinfosrc=hoverinfosrc,
+ hoverlabel=hoverlabel,
+ hovertemplate=hovertemplate,
+ hovertemplatesrc=hovertemplatesrc,
+ hovertext=hovertext,
+ hovertextsrc=hovertextsrc,
+ ids=ids,
+ idssrc=idssrc,
+ lat=lat,
+ latsrc=latsrc,
+ legend=legend,
+ legendgroup=legendgroup,
+ legendgrouptitle=legendgrouptitle,
+ legendrank=legendrank,
+ legendwidth=legendwidth,
+ lon=lon,
+ lonsrc=lonsrc,
+ meta=meta,
+ metasrc=metasrc,
+ name=name,
+ opacity=opacity,
+ radius=radius,
+ radiussrc=radiussrc,
+ reversescale=reversescale,
+ showlegend=showlegend,
+ showscale=showscale,
+ stream=stream,
+ subplot=subplot,
+ text=text,
+ textsrc=textsrc,
+ uid=uid,
+ uirevision=uirevision,
+ visible=visible,
+ z=z,
+ zauto=zauto,
+ zmax=zmax,
+ zmid=zmid,
+ zmin=zmin,
+ zsrc=zsrc,
+ **kwargs,
+ )
+ return self.add_trace(new_trace, row=row, col=col)
+
+ def add_funnel(
+ self,
+ alignmentgroup=None,
+ cliponaxis=None,
+ connector=None,
+ constraintext=None,
+ customdata=None,
+ customdatasrc=None,
+ dx=None,
+ dy=None,
+ hoverinfo=None,
+ hoverinfosrc=None,
+ hoverlabel=None,
+ hovertemplate=None,
+ hovertemplatesrc=None,
+ hovertext=None,
+ hovertextsrc=None,
+ ids=None,
+ idssrc=None,
+ insidetextanchor=None,
+ insidetextfont=None,
+ legend=None,
+ legendgroup=None,
+ legendgrouptitle=None,
+ legendrank=None,
+ legendwidth=None,
+ marker=None,
+ meta=None,
+ metasrc=None,
+ name=None,
+ offset=None,
+ offsetgroup=None,
+ opacity=None,
+ orientation=None,
+ outsidetextfont=None,
+ selectedpoints=None,
+ showlegend=None,
+ stream=None,
+ text=None,
+ textangle=None,
+ textfont=None,
+ textinfo=None,
+ textposition=None,
+ textpositionsrc=None,
+ textsrc=None,
+ texttemplate=None,
+ texttemplatesrc=None,
+ uid=None,
+ uirevision=None,
+ visible=None,
+ width=None,
+ x=None,
+ x0=None,
+ xaxis=None,
+ xhoverformat=None,
+ xperiod=None,
+ xperiod0=None,
+ xperiodalignment=None,
+ xsrc=None,
+ y=None,
+ y0=None,
+ yaxis=None,
+ yhoverformat=None,
+ yperiod=None,
+ yperiod0=None,
+ yperiodalignment=None,
+ ysrc=None,
+ zorder=None,
+ row=None,
+ col=None,
+ secondary_y=None,
+ **kwargs,
+ ) -> "Figure":
+ """
+ Add a new Funnel trace
+
+ Visualize stages in a process using length-encoded bars. This
+ trace can be used to show data in either a part-to-whole
+ representation wherein each item appears in a single stage, or
+ in a "drop-off" representation wherein each item appears in
+ each stage it traversed. See also the "funnelarea" trace type
+ for a different approach to visualizing funnel data.
+
+ Parameters
+ ----------
+ alignmentgroup
+ Set several traces linked to the same position axis or
+ matching axes to the same alignmentgroup. This controls
+ whether bars compute their positional range dependently
+ or independently.
+ cliponaxis
+ Determines whether the text nodes are clipped about the
+ subplot axes. To show the text nodes above axis lines
+ and tick labels, make sure to set `xaxis.layer` and
+ `yaxis.layer` to *below traces*.
+ connector
+ :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.
+ customdata
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note
+ that, "scatter" traces also appends customdata items in
+ the markers DOM elements
+ customdatasrc
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+ dx
+ Sets the x coordinate step. See `x0` for more info.
+ dy
+ Sets the y coordinate step. See `y0` for more info.
+ hoverinfo
+ Determines which trace information appear on hover. If
+ `none` or `skip` are set, no information is displayed
+ upon hovering. But, if `none` is set, click and hover
+ events are still fired.
+ hoverinfosrc
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
+ hoverlabel
+ :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
+ `hoverinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}" as well as %{xother}, {%_xother},
+ {%_xother_}, {%xother_}. When showing info for several
+ points, "xother" will be added to those with different
+ x positions from the first point. An underscore before
+ or after "(x|y)other" will add a space on that side,
+ only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for
+ example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. The variables available in
+ `hovertemplate` are the ones emitted as event data
+ described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-
+ data. Additionally, every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Finally, the template string has access
+ to variables `percentInitial`, `percentPrevious` and
+ `percentTotal`. Anything contained in tag `` is
+ displayed in the secondary box, for example
+ "{fullData.name}". To hide the secondary
+ box completely, use an empty tag ``.
+ hovertemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+ hovertext
+ Sets hover text elements associated with each (x,y)
+ pair. If a single string, the same string appears over
+ all the data points. If an array of string, the items
+ are mapped in order to the this trace's (x,y)
+ coordinates. To be seen, trace `hoverinfo` must contain
+ a "text" flag.
+ hovertextsrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
+ ids
+ Assigns id labels to each datum. These ids for object
+ constancy of data points during animation. Should be an
+ array of strings, not numbers or any other type.
+ idssrc
+ Sets the source reference on Chart Studio Cloud for
+ `ids`.
+ insidetextanchor
+ Determines if texts are kept at center or start/end
+ points in `textposition` "inside" mode.
+ insidetextfont
+ Sets the font used for `text` lying inside the bar.
+ legend
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2",
+ "legend3", etc. Settings for these legends are set in
+ the layout, under `layout.legend`, `layout.legend2`,
+ etc.
+ legendgroup
+ Sets the legend group for this trace. Traces and shapes
+ part of the same legend group hide/show at the same
+ time when toggling legend items.
+ legendgrouptitle
+ :class:`plotly.graph_objects.funnel.Legendgrouptitle`
+ instance or dict with compatible properties
+ legendrank
+ Sets the legend rank for this trace. Items and groups
+ with smaller ranks are presented on top/left side while
+ with "reversed" `legend.traceorder` they are on
+ bottom/right side. The default legendrank is 1000, so
+ that you can use ranks less than 1000 to place certain
+ items before all unranked items, and ranks greater than
+ 1000 to go after all unranked items. When having
+ unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and
+ layout.
+ legendwidth
+ Sets the width (in px or fraction) of the legend for
+ this trace.
+ marker
+ :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.
+ Attributes such as trace `name`, graph, axis and
+ colorbar `title.text`, annotation `text`
+ `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta`
+ values in an attribute in the same trace, simply use
+ `%{meta[i]}` where `i` is the index or key of the
+ `meta` item in question. To access trace `meta` in
+ layout attributes, use `%{data[n[.meta[i]}` where `i`
+ is the index or key of the `meta` and `n` is the trace
+ index.
+ metasrc
+ Sets the source reference on Chart Studio Cloud for
+ `meta`.
+ name
+ Sets the trace name. The trace name appears as the
+ legend item and on hover.
+ offset
Shifts the position where the bar is drawn (in position
axis units). In "group" barmode, traces that set
"offset" will be excluded and drawn in "overlay" mode
@@ -12989,99 +13769,378 @@ def add_pointcloud(
"""
from plotly.graph_objs import Pointcloud
- new_trace = Pointcloud(
+ new_trace = Pointcloud(
+ customdata=customdata,
+ customdatasrc=customdatasrc,
+ hoverinfo=hoverinfo,
+ hoverinfosrc=hoverinfosrc,
+ hoverlabel=hoverlabel,
+ ids=ids,
+ idssrc=idssrc,
+ indices=indices,
+ indicessrc=indicessrc,
+ legend=legend,
+ legendgroup=legendgroup,
+ legendgrouptitle=legendgrouptitle,
+ legendrank=legendrank,
+ legendwidth=legendwidth,
+ marker=marker,
+ meta=meta,
+ metasrc=metasrc,
+ name=name,
+ opacity=opacity,
+ showlegend=showlegend,
+ stream=stream,
+ text=text,
+ textsrc=textsrc,
+ uid=uid,
+ uirevision=uirevision,
+ visible=visible,
+ x=x,
+ xaxis=xaxis,
+ xbounds=xbounds,
+ xboundssrc=xboundssrc,
+ xsrc=xsrc,
+ xy=xy,
+ xysrc=xysrc,
+ y=y,
+ yaxis=yaxis,
+ ybounds=ybounds,
+ yboundssrc=yboundssrc,
+ ysrc=ysrc,
+ **kwargs,
+ )
+ return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y)
+
+ def add_sankey(
+ self,
+ arrangement=None,
+ customdata=None,
+ customdatasrc=None,
+ domain=None,
+ hoverinfo=None,
+ hoverlabel=None,
+ ids=None,
+ idssrc=None,
+ legend=None,
+ legendgrouptitle=None,
+ legendrank=None,
+ legendwidth=None,
+ link=None,
+ meta=None,
+ metasrc=None,
+ name=None,
+ node=None,
+ orientation=None,
+ selectedpoints=None,
+ stream=None,
+ textfont=None,
+ uid=None,
+ uirevision=None,
+ valueformat=None,
+ valuesuffix=None,
+ visible=None,
+ row=None,
+ col=None,
+ **kwargs,
+ ) -> "Figure":
+ """
+ Add a new Sankey trace
+
+ Sankey plots for network flow data analysis. The nodes are
+ specified in `nodes` and the links between sources and targets
+ in `links`. The colors are set in `nodes[i].color` and
+ `links[i].color`, otherwise defaults are used.
+
+ Parameters
+ ----------
+ arrangement
+ If value is `snap` (the default), the node arrangement
+ is assisted by automatic snapping of elements to
+ preserve space between nodes specified via `nodepad`.
+ If value is `perpendicular`, the nodes can only move
+ along a line perpendicular to the flow. If value is
+ `freeform`, the nodes can freely move on the plane. If
+ value is `fixed`, the nodes are stationary.
+ customdata
+ Assigns extra data each datum. This may be useful when
+ listening to hover, click and selection events. Note
+ that, "scatter" traces also appends customdata items in
+ the markers DOM elements
+ customdatasrc
+ Sets the source reference on Chart Studio Cloud for
+ `customdata`.
+ domain
+ :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
+ upon hovering. But, if `none` is set, click and hover
+ events are still fired. Note that this attribute is
+ superseded by `node.hoverinfo` and `node.hoverinfo` for
+ nodes and links respectively.
+ hoverlabel
+ :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
+ array of strings, not numbers or any other type.
+ idssrc
+ Sets the source reference on Chart Studio Cloud for
+ `ids`.
+ legend
+ Sets the reference to a legend to show this trace in.
+ References to these legends are "legend", "legend2",
+ "legend3", etc. Settings for these legends are set in
+ the layout, under `layout.legend`, `layout.legend2`,
+ etc.
+ legendgrouptitle
+ :class:`plotly.graph_objects.sankey.Legendgrouptitle`
+ instance or dict with compatible properties
+ legendrank
+ Sets the legend rank for this trace. Items and groups
+ with smaller ranks are presented on top/left side while
+ with "reversed" `legend.traceorder` they are on
+ bottom/right side. The default legendrank is 1000, so
+ that you can use ranks less than 1000 to place certain
+ items before all unranked items, and ranks greater than
+ 1000 to go after all unranked items. When having
+ unranked or equal rank items shapes would be displayed
+ after traces i.e. according to their order in data and
+ layout.
+ legendwidth
+ Sets the width (in px or fraction) of the legend for
+ this trace.
+ link
+ The links of the Sankey plot.
+ meta
+ Assigns extra meta information associated with this
+ trace that can be used in various text attributes.
+ Attributes such as trace `name`, graph, axis and
+ colorbar `title.text`, annotation `text`
+ `rangeselector`, `updatemenues` and `sliders` `label`
+ text all support `meta`. To access the trace `meta`
+ values in an attribute in the same trace, simply use
+ `%{meta[i]}` where `i` is the index or key of the
+ `meta` item in question. To access trace `meta` in
+ layout attributes, use `%{data[n[.meta[i]}` where `i`
+ is the index or key of the `meta` and `n` is the trace
+ index.
+ metasrc
+ Sets the source reference on Chart Studio Cloud for
+ `meta`.
+ name
+ Sets the trace name. The trace name appears as the
+ legend item and on hover.
+ node
+ The nodes of the Sankey plot.
+ orientation
+ Sets the orientation of the Sankey diagram.
+ selectedpoints
+ Array containing integer indices of selected points.
+ Has an effect only for traces that support selections.
+ Note that an empty array means an empty selection where
+ the `unselected` are turned on for all points, whereas,
+ any other non-array values means no selection all where
+ the `selected` and `unselected` styles have no effect.
+ stream
+ :class:`plotly.graph_objects.sankey.Stream` instance or
+ dict with compatible properties
+ textfont
+ Sets the font for node labels
+ uid
+ Assign an id to this trace, Use this to provide object
+ constancy between traces during animations and
+ transitions.
+ uirevision
+ Controls persistence of some user-driven changes to the
+ trace: `constraintrange` in `parcoords` traces, as well
+ as some `editable: true` modifications such as `name`
+ and `colorbar.title`. Defaults to `layout.uirevision`.
+ Note that other user-driven trace attribute changes are
+ controlled by `layout` attributes: `trace.visible` is
+ controlled by `layout.legend.uirevision`,
+ `selectedpoints` is controlled by
+ `layout.selectionrevision`, and `colorbar.(x|y)`
+ (accessible with `config: {editable: true}`) is
+ controlled by `layout.editrevision`. Trace changes are
+ tracked by `uid`, which only falls back on trace index
+ if no `uid` is provided. So if your app can add/remove
+ traces before the end of the `data` array, such that
+ the same trace has a different index, you can still
+ preserve user-driven changes if you give each trace a
+ `uid` that stays with it as it moves.
+ valueformat
+ Sets the value formatting rule using d3 formatting
+ mini-languages which are very similar to those in
+ Python. For numbers, see:
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
+ valuesuffix
+ Adds a unit to follow the value in the hover tooltip.
+ Add a space if a separation is necessary from the
+ value.
+ visible
+ Determines whether or not this trace is visible. If
+ "legendonly", the trace is not drawn, but can appear as
+ a legend item (provided that the legend itself is
+ visible).
+ row : 'all', int or None (default)
+ Subplot row index (starting from 1) for the trace to be
+ added. Only valid if figure was created using
+ `plotly.tools.make_subplots`.If 'all', addresses all
+ rows in the specified column(s).
+ col : 'all', int or None (default)
+ Subplot col index (starting from 1) for the trace to be
+ added. Only valid if figure was created using
+ `plotly.tools.make_subplots`.If 'all', addresses all
+ columns in the specified row(s).
+
+ Returns
+ -------
+ Figure
+ """
+ from plotly.graph_objs import Sankey
+
+ new_trace = Sankey(
+ arrangement=arrangement,
customdata=customdata,
customdatasrc=customdatasrc,
+ domain=domain,
hoverinfo=hoverinfo,
- hoverinfosrc=hoverinfosrc,
hoverlabel=hoverlabel,
ids=ids,
idssrc=idssrc,
- indices=indices,
- indicessrc=indicessrc,
legend=legend,
- legendgroup=legendgroup,
legendgrouptitle=legendgrouptitle,
legendrank=legendrank,
legendwidth=legendwidth,
- marker=marker,
+ link=link,
meta=meta,
metasrc=metasrc,
name=name,
- opacity=opacity,
- showlegend=showlegend,
+ node=node,
+ orientation=orientation,
+ selectedpoints=selectedpoints,
stream=stream,
- text=text,
- textsrc=textsrc,
+ textfont=textfont,
uid=uid,
uirevision=uirevision,
+ valueformat=valueformat,
+ valuesuffix=valuesuffix,
visible=visible,
- x=x,
- xaxis=xaxis,
- xbounds=xbounds,
- xboundssrc=xboundssrc,
- xsrc=xsrc,
- xy=xy,
- xysrc=xysrc,
- y=y,
- yaxis=yaxis,
- ybounds=ybounds,
- yboundssrc=yboundssrc,
- ysrc=ysrc,
**kwargs,
)
- return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y)
+ return self.add_trace(new_trace, row=row, col=col)
- def add_sankey(
+ def add_scatter(
self,
- arrangement=None,
+ alignmentgroup=None,
+ cliponaxis=None,
+ connectgaps=None,
customdata=None,
customdatasrc=None,
- domain=None,
+ dx=None,
+ dy=None,
+ error_x=None,
+ error_y=None,
+ fill=None,
+ fillcolor=None,
+ fillgradient=None,
+ fillpattern=None,
+ groupnorm=None,
hoverinfo=None,
+ hoverinfosrc=None,
hoverlabel=None,
+ hoveron=None,
+ hovertemplate=None,
+ hovertemplatesrc=None,
+ hovertext=None,
+ hovertextsrc=None,
ids=None,
idssrc=None,
legend=None,
+ legendgroup=None,
legendgrouptitle=None,
legendrank=None,
legendwidth=None,
- link=None,
+ line=None,
+ marker=None,
meta=None,
metasrc=None,
+ mode=None,
name=None,
- node=None,
+ offsetgroup=None,
+ opacity=None,
orientation=None,
+ selected=None,
selectedpoints=None,
+ showlegend=None,
+ stackgaps=None,
+ stackgroup=None,
stream=None,
+ text=None,
textfont=None,
+ textposition=None,
+ textpositionsrc=None,
+ textsrc=None,
+ texttemplate=None,
+ texttemplatesrc=None,
uid=None,
uirevision=None,
- valueformat=None,
- valuesuffix=None,
+ unselected=None,
visible=None,
+ x=None,
+ x0=None,
+ xaxis=None,
+ xcalendar=None,
+ xhoverformat=None,
+ xperiod=None,
+ xperiod0=None,
+ xperiodalignment=None,
+ xsrc=None,
+ y=None,
+ y0=None,
+ yaxis=None,
+ ycalendar=None,
+ yhoverformat=None,
+ yperiod=None,
+ yperiod0=None,
+ yperiodalignment=None,
+ ysrc=None,
+ zorder=None,
row=None,
col=None,
+ secondary_y=None,
**kwargs,
) -> "Figure":
"""
- Add a new Sankey trace
+ Add a new Scatter trace
- Sankey plots for network flow data analysis. The nodes are
- specified in `nodes` and the links between sources and targets
- in `links`. The colors are set in `nodes[i].color` and
- `links[i].color`, otherwise defaults are used.
+ The scatter trace type encompasses line charts, scatter charts,
+ text charts, and bubble charts. The data visualized as scatter
+ point or lines is set in `x` and `y`. Text (appearing either on
+ the chart or on hover only) is via `text`. Bubble charts are
+ achieved by setting `marker.size` and/or `marker.color` to
+ numerical arrays.
Parameters
----------
- arrangement
- If value is `snap` (the default), the node arrangement
- is assisted by automatic snapping of elements to
- preserve space between nodes specified via `nodepad`.
- If value is `perpendicular`, the nodes can only move
- along a line perpendicular to the flow. If value is
- `freeform`, the nodes can freely move on the plane. If
- value is `fixed`, the nodes are stationary.
+ alignmentgroup
+ Set several traces linked to the same position axis or
+ matching axes to the same alignmentgroup. This controls
+ whether bars compute their positional range dependently
+ or independently.
+ cliponaxis
+ Determines whether or not markers and text nodes are
+ clipped about the subplot axes. To show markers and
+ text nodes above axis lines and tick labels, make sure
+ to set `xaxis.layer` and `yaxis.layer` to *below
+ traces*.
+ connectgaps
+ Determines whether or not gaps (i.e. {nan} or missing
+ values) in the provided data arrays are connected.
customdata
Assigns extra data each datum. This may be useful when
listening to hover, click and selection events. Note
@@ -13090,19 +14149,119 @@ def add_sankey(
customdatasrc
Sets the source reference on Chart Studio Cloud for
`customdata`.
- domain
- :class:`plotly.graph_objects.sankey.Domain` instance or
- dict with compatible properties
+ dx
+ Sets the x coordinate step. See `x0` for more info.
+ dy
+ Sets the y coordinate step. See `y0` for more info.
+ error_x
+ :class:`plotly.graph_objects.scatter.ErrorX` instance
+ or dict with compatible properties
+ error_y
+ :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
+ "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
+ with `fillcolor` if not "none". "tozerox" and "tozeroy"
+ fill to x=0 and y=0 respectively. "tonextx" and
+ "tonexty" fill between the endpoints of this trace and
+ the endpoints of the trace before it, connecting those
+ endpoints with straight lines (to make a stacked area
+ graph); if there is no trace before it, they behave
+ like "tozerox" and "tozeroy". "toself" connects the
+ endpoints of the trace (or each segment of the trace if
+ it has gaps) into a closed shape. "tonext" fills the
+ space between two traces if one completely encloses the
+ other (eg consecutive contour lines), and behaves like
+ "toself" if there is no trace before it. "tonext"
+ should not be used if one trace does not enclose the
+ other. Traces in a `stackgroup` will only fill to (or
+ be filled to) other traces in the same group. With
+ multiple `stackgroup`s or some traces stacked and some
+ not, if fill-linked traces are not already consecutive,
+ the later ones will be pushed down in the drawing
+ order.
+ fillcolor
+ Sets the fill color. Defaults to a half-transparent
+ variant of the line color, marker color, or marker line
+ color, whichever is available. If fillgradient is
+ specified, fillcolor is ignored except for setting the
+ background color of the hover label, if any.
+ fillgradient
+ Sets a fill gradient. If not specified, the fillcolor
+ is used instead.
+ fillpattern
+ Sets the pattern within the marker.
+ groupnorm
+ Only relevant when `stackgroup` is used, and only the
+ first `groupnorm` found in the `stackgroup` will be
+ used - including if `visible` is "legendonly" but not
+ if it is `false`. Sets the normalization for the sum of
+ this `stackgroup`. With "fraction", the value of each
+ trace at each location is divided by the sum of all
+ trace values at that location. "percent" is the same
+ but multiplied by 100 to show percentages. If there are
+ multiple subplots, or multiple `stackgroup`s on one
+ subplot, each will be normalized within its own set.
hoverinfo
Determines which trace information appear on hover. If
`none` or `skip` are set, no information is displayed
upon hovering. But, if `none` is set, click and hover
- events are still fired. Note that this attribute is
- superseded by `node.hoverinfo` and `node.hoverinfo` for
- nodes and links respectively.
+ events are still fired.
+ hoverinfosrc
+ Sets the source reference on Chart Studio Cloud for
+ `hoverinfo`.
hoverlabel
- :class:`plotly.graph_objects.sankey.Hoverlabel`
+ :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
+ regions? If the fill is "toself" or "tonext" and there
+ are no markers or text, then the default is "fills",
+ otherwise it is "points".
+ hovertemplate
+ Template string used for rendering the information that
+ appear on hover box. Note that this will override
+ `hoverinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}" as well as %{xother}, {%_xother},
+ {%_xother_}, {%xother_}. When showing info for several
+ points, "xother" will be added to those with different
+ x positions from the first point. An underscore before
+ or after "(x|y)other" will add a space on that side,
+ only when this field is shown. Numbers are formatted
+ using d3-format's syntax %{variable:d3-format}, for
+ example "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. The variables available in
+ `hovertemplate` are the ones emitted as event data
+ described at this link
+ https://plotly.com/javascript/plotlyjs-events/#event-
+ data. Additionally, every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available. Anything contained in tag `` is
+ displayed in the secondary box, for example
+ "{fullData.name}". To hide the secondary
+ box completely, use an empty tag ``.
+ hovertemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertemplate`.
+ hovertext
+ Sets hover text elements associated with each (x,y)
+ pair. If a single string, the same string appears over
+ all the data points. If an array of string, the items
+ are mapped in order to the this trace's (x,y)
+ coordinates. To be seen, trace `hoverinfo` must contain
+ a "text" flag.
+ hovertextsrc
+ Sets the source reference on Chart Studio Cloud for
+ `hovertext`.
ids
Assigns id labels to each datum. These ids for object
constancy of data points during animation. Should be an
@@ -13116,8 +14275,12 @@ def add_sankey(
"legend3", etc. Settings for these legends are set in
the layout, under `layout.legend`, `layout.legend2`,
etc.
+ legendgroup
+ Sets the legend group for this trace. Traces and shapes
+ part of the same legend group hide/show at the same
+ time when toggling legend items.
legendgrouptitle
- :class:`plotly.graph_objects.sankey.Legendgrouptitle`
+ :class:`plotly.graph_objects.scatter.Legendgrouptitle`
instance or dict with compatible properties
legendrank
Sets the legend rank for this trace. Items and groups
@@ -13133,8 +14296,12 @@ def add_sankey(
legendwidth
Sets the width (in px or fraction) of the legend for
this trace.
- link
- The links of the Sankey plot.
+ line
+ :class:`plotly.graph_objects.scatter.Line` instance or
+ dict with compatible properties
+ marker
+ :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.
@@ -13151,13 +14318,34 @@ def add_sankey(
metasrc
Sets the source reference on Chart Studio Cloud for
`meta`.
+ mode
+ Determines the drawing mode for this scatter trace. If
+ the provided `mode` includes "text" then the `text`
+ elements appear at the coordinates. Otherwise, the
+ `text` elements appear on hover. If there are less than
+ 20 points and the trace is not stacked then the default
+ is "lines+markers". Otherwise, "lines".
name
Sets the trace name. The trace name appears as the
legend item and on hover.
- node
- The nodes of the Sankey plot.
+ offsetgroup
+ Set several traces linked to the same position axis or
+ matching axes to the same offsetgroup where bars of the
+ same position coordinate will line up.
+ opacity
+ Sets the opacity of the trace.
orientation
- Sets the orientation of the Sankey diagram.
+ Only relevant in the following cases: 1. when
+ `scattermode` is set to "group". 2. when `stackgroup`
+ is used, and only the first `orientation` found in the
+ `stackgroup` will be used - including if `visible` is
+ "legendonly" but not if it is `false`. Sets the
+ stacking direction. With "v" ("h"), the y (x) values of
+ subsequent traces are added. Also affects the default
+ value of `fill`.
+ selected
+ :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.
@@ -13165,11 +14353,74 @@ def add_sankey(
the `unselected` are turned on for all points, whereas,
any other non-array values means no selection all where
the `selected` and `unselected` styles have no effect.
+ showlegend
+ Determines whether or not an item corresponding to this
+ trace is shown in the legend.
+ stackgaps
+ Only relevant when `stackgroup` is used, and only the
+ first `stackgaps` found in the `stackgroup` will be
+ used - including if `visible` is "legendonly" but not
+ if it is `false`. Determines how we handle locations at
+ which other traces in this group have data but this one
+ does not. With *infer zero* we insert a zero at these
+ locations. With "interpolate" we linearly interpolate
+ between existing values, and extrapolate a constant
+ beyond the existing values.
+ stackgroup
+ Set several scatter traces (on the same subplot) to the
+ same stackgroup in order to add their y values (or
+ their x values if `orientation` is "h"). If blank or
+ omitted this trace will not be stacked. Stacking also
+ turns `fill` on by default, using "tonexty" ("tonextx")
+ if `orientation` is "h" ("v") and sets the default
+ `mode` to "lines" irrespective of point count. You can
+ only stack on a numeric (linear or log) axis. Traces in
+ a `stackgroup` will only fill to (or be filled to)
+ other traces in the same group. With multiple
+ `stackgroup`s or some traces stacked and some not, if
+ fill-linked traces are not already consecutive, the
+ later ones will be pushed down in the drawing order.
stream
- :class:`plotly.graph_objects.sankey.Stream` instance or
- dict with compatible properties
+ :class:`plotly.graph_objects.scatter.Stream` instance
+ or dict with compatible properties
+ text
+ Sets text elements associated with each (x,y) pair. If
+ a single string, the same string appears over all the
+ data points. If an array of string, the items are
+ mapped in order to the this trace's (x,y) coordinates.
+ If trace `hoverinfo` contains a "text" flag and
+ "hovertext" is not set, these elements will be seen in
+ the hover labels.
textfont
- Sets the font for node labels
+ Sets the text font.
+ textposition
+ Sets the positions of the `text` elements with respects
+ to the (x,y) coordinates.
+ textpositionsrc
+ Sets the source reference on Chart Studio Cloud for
+ `textposition`.
+ textsrc
+ Sets the source reference on Chart Studio Cloud for
+ `text`.
+ texttemplate
+ Template string used for rendering the information text
+ that appear on points. Note that this will override
+ `textinfo`. Variables are inserted using %{variable},
+ for example "y: %{y}". Numbers are formatted using
+ d3-format's syntax %{variable:d3-format}, for example
+ "Price: %{y:$.2f}".
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format
+ for details on the formatting syntax. Dates are
+ formatted using d3-time-format's syntax
+ %{variable|d3-time-format}, for example "Day:
+ %{2019-01-01|%A}". https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format for details on the
+ date formatting syntax. Every attributes that can be
+ specified per-point (the ones that are `arrayOk: true`)
+ are available.
+ texttemplatesrc
+ Sets the source reference on Chart Studio Cloud for
+ `texttemplate`.
uid
Assign an id to this trace, Use this to provide object
constancy between traces during animations and
@@ -13192,20 +14443,109 @@ def add_sankey(
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
`uid` that stays with it as it moves.
- valueformat
- Sets the value formatting rule using d3 formatting
- mini-languages which are very similar to those in
- Python. For numbers, see:
- https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
- valuesuffix
- Adds a unit to follow the value in the hover tooltip.
- Add a space if a separation is necessary from the
- value.
+ unselected
+ :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
a legend item (provided that the legend itself is
visible).
+ x
+ Sets the x coordinates.
+ x0
+ Alternate to `x`. Builds a linear space of x
+ coordinates. Use with `dx` where `x0` is the starting
+ coordinate and `dx` the step.
+ xaxis
+ Sets a reference between this trace's x coordinates and
+ a 2D cartesian x axis. If "x" (the default value), the
+ x coordinates refer to `layout.xaxis`. If "x2", the x
+ coordinates refer to `layout.xaxis2`, and so on.
+ xcalendar
+ Sets the calendar system to use with `x` date data.
+ xhoverformat
+ Sets the hover text formatting rulefor `x` using d3
+ formatting mini-languages which are very similar to
+ those in Python. For numbers, see:
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
+ And for dates see: https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format. We add two items to
+ d3's date formatter: "%h" for half of the year as a
+ decimal number as well as "%{n}f" for fractional
+ seconds with n digits. For example, *2016-10-13
+ 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
+ display *09~15~23.46*By default the values are
+ formatted using `xaxis.hoverformat`.
+ xperiod
+ Only relevant when the axis `type` is "date". Sets the
+ period positioning in milliseconds or "M" on the x
+ axis. Special values in the form of "M" could be
+ used to declare the number of months. In this case `n`
+ must be a positive integer.
+ xperiod0
+ Only relevant when the axis `type` is "date". Sets the
+ base for period positioning in milliseconds or date
+ string on the x0 axis. When `x0period` is round number
+ of weeks, the `x0period0` by default would be on a
+ Sunday i.e. 2000-01-02, otherwise it would be at
+ 2000-01-01.
+ xperiodalignment
+ Only relevant when the axis `type` is "date". Sets the
+ alignment of data points on the x axis.
+ xsrc
+ Sets the source reference on Chart Studio Cloud for
+ `x`.
+ y
+ Sets the y coordinates.
+ y0
+ Alternate to `y`. Builds a linear space of y
+ coordinates. Use with `dy` where `y0` is the starting
+ coordinate and `dy` the step.
+ yaxis
+ Sets a reference between this trace's y coordinates and
+ a 2D cartesian y axis. If "y" (the default value), the
+ y coordinates refer to `layout.yaxis`. If "y2", the y
+ coordinates refer to `layout.yaxis2`, and so on.
+ ycalendar
+ Sets the calendar system to use with `y` date data.
+ yhoverformat
+ Sets the hover text formatting rulefor `y` using d3
+ formatting mini-languages which are very similar to
+ those in Python. For numbers, see:
+ https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
+ And for dates see: https://github.com/d3/d3-time-
+ format/tree/v2.2.3#locale_format. We add two items to
+ d3's date formatter: "%h" for half of the year as a
+ decimal number as well as "%{n}f" for fractional
+ seconds with n digits. For example, *2016-10-13
+ 09:15:23.456* with tickformat "%H~%M~%S.%2f" would
+ display *09~15~23.46*By default the values are
+ formatted using `yaxis.hoverformat`.
+ yperiod
+ Only relevant when the axis `type` is "date". Sets the
+ period positioning in milliseconds or "M" on the y
+ axis. Special values in the form of "M" could be
+ used to declare the number of months. In this case `n`
+ must be a positive integer.
+ yperiod0
+ Only relevant when the axis `type` is "date". Sets the
+ base for period positioning in milliseconds or date
+ string on the y0 axis. When `y0period` is round number
+ of weeks, the `y0period0` by default would be on a
+ Sunday i.e. 2000-01-02, otherwise it would be at
+ 2000-01-01.
+ yperiodalignment
+ Only relevant when the axis `type` is "date". Sets the
+ alignment of data points on the y axis.
+ ysrc
+ Sets the source reference on Chart Studio Cloud for
+ `y`.
+ zorder
+ Sets the layer on which this trace is displayed,
+ relative to other SVG traces on the same subplot. SVG
+ traces with higher `zorder` appear in front of those
+ with lower `zorder`.
row : 'all', int or None (default)
Subplot row index (starting from 1) for the trace to be
added. Only valid if figure was created using
@@ -13216,64 +14556,113 @@ def add_sankey(
added. Only valid if figure was created using
`plotly.tools.make_subplots`.If 'all', addresses all
columns in the specified row(s).
+ secondary_y: boolean or None (default None)
+ If True, associate this trace with the secondary y-axis of the
+ subplot at the specified row and col. Only valid if all of the
+ following conditions are satisfied:
+ * The figure was created using `plotly.subplots.make_subplots`.
+ * The row and col arguments are not None
+ * The subplot at the specified row and col has type xy
+ (which is the default) and secondary_y True. These
+ properties are specified in the specs argument to
+ make_subplots. See the make_subplots docstring for more info.
Returns
-------
Figure
"""
- from plotly.graph_objs import Sankey
+ from plotly.graph_objs import Scatter
- new_trace = Sankey(
- arrangement=arrangement,
+ new_trace = Scatter(
+ alignmentgroup=alignmentgroup,
+ cliponaxis=cliponaxis,
+ connectgaps=connectgaps,
customdata=customdata,
customdatasrc=customdatasrc,
- domain=domain,
+ dx=dx,
+ dy=dy,
+ error_x=error_x,
+ error_y=error_y,
+ fill=fill,
+ fillcolor=fillcolor,
+ fillgradient=fillgradient,
+ fillpattern=fillpattern,
+ groupnorm=groupnorm,
hoverinfo=hoverinfo,
+ hoverinfosrc=hoverinfosrc,
hoverlabel=hoverlabel,
+ hoveron=hoveron,
+ hovertemplate=hovertemplate,
+ hovertemplatesrc=hovertemplatesrc,
+ hovertext=hovertext,
+ hovertextsrc=hovertextsrc,
ids=ids,
idssrc=idssrc,
legend=legend,
+ legendgroup=legendgroup,
legendgrouptitle=legendgrouptitle,
legendrank=legendrank,
legendwidth=legendwidth,
- link=link,
+ line=line,
+ marker=marker,
meta=meta,
metasrc=metasrc,
+ mode=mode,
name=name,
- node=node,
+ offsetgroup=offsetgroup,
+ opacity=opacity,
orientation=orientation,
+ selected=selected,
selectedpoints=selectedpoints,
+ showlegend=showlegend,
+ stackgaps=stackgaps,
+ stackgroup=stackgroup,
stream=stream,
+ text=text,
textfont=textfont,
+ textposition=textposition,
+ textpositionsrc=textpositionsrc,
+ textsrc=textsrc,
+ texttemplate=texttemplate,
+ texttemplatesrc=texttemplatesrc,
uid=uid,
uirevision=uirevision,
- valueformat=valueformat,
- valuesuffix=valuesuffix,
+ unselected=unselected,
visible=visible,
+ x=x,
+ x0=x0,
+ xaxis=xaxis,
+ xcalendar=xcalendar,
+ xhoverformat=xhoverformat,
+ xperiod=xperiod,
+ xperiod0=xperiod0,
+ xperiodalignment=xperiodalignment,
+ xsrc=xsrc,
+ y=y,
+ y0=y0,
+ yaxis=yaxis,
+ ycalendar=ycalendar,
+ yhoverformat=yhoverformat,
+ yperiod=yperiod,
+ yperiod0=yperiod0,
+ yperiodalignment=yperiodalignment,
+ ysrc=ysrc,
+ zorder=zorder,
**kwargs,
)
- return self.add_trace(new_trace, row=row, col=col)
+ return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y)
- def add_scatter(
+ def add_scatter3d(
self,
- alignmentgroup=None,
- cliponaxis=None,
connectgaps=None,
customdata=None,
customdatasrc=None,
- dx=None,
- dy=None,
error_x=None,
error_y=None,
- fill=None,
- fillcolor=None,
- fillgradient=None,
- fillpattern=None,
- groupnorm=None,
+ error_z=None,
hoverinfo=None,
hoverinfosrc=None,
hoverlabel=None,
- hoveron=None,
hovertemplate=None,
hovertemplatesrc=None,
hovertext=None,
@@ -13291,15 +14680,13 @@ def add_scatter(
metasrc=None,
mode=None,
name=None,
- offsetgroup=None,
opacity=None,
- orientation=None,
- selected=None,
- selectedpoints=None,
+ projection=None,
+ scene=None,
showlegend=None,
- stackgaps=None,
- stackgroup=None,
stream=None,
+ surfaceaxis=None,
+ surfacecolor=None,
text=None,
textfont=None,
textposition=None,
@@ -13309,55 +14696,35 @@ def add_scatter(
texttemplatesrc=None,
uid=None,
uirevision=None,
- unselected=None,
visible=None,
x=None,
- x0=None,
- xaxis=None,
xcalendar=None,
xhoverformat=None,
- xperiod=None,
- xperiod0=None,
- xperiodalignment=None,
xsrc=None,
y=None,
- y0=None,
- yaxis=None,
ycalendar=None,
yhoverformat=None,
- yperiod=None,
- yperiod0=None,
- yperiodalignment=None,
ysrc=None,
- zorder=None,
+ z=None,
+ zcalendar=None,
+ zhoverformat=None,
+ zsrc=None,
row=None,
col=None,
- secondary_y=None,
**kwargs,
) -> "Figure":
"""
- Add a new Scatter trace
+ Add a new Scatter3d trace
- The scatter trace type encompasses line charts, scatter charts,
- text charts, and bubble charts. The data visualized as scatter
- point or lines is set in `x` and `y`. Text (appearing either on
- the chart or on hover only) is via `text`. Bubble charts are
- achieved by setting `marker.size` and/or `marker.color` to
- numerical arrays.
+ The data visualized as scatter point or lines in 3D dimension
+ is set in `x`, `y`, `z`. Text (appearing either on the chart or
+ on hover only) is via `text`. Bubble charts are achieved by
+ setting `marker.size` and/or `marker.color` Projections are
+ achieved via `projection`. Surface fills are achieved via
+ `surfaceaxis`.
Parameters
----------
- alignmentgroup
- Set several traces linked to the same position axis or
- matching axes to the same alignmentgroup. This controls
- whether bars compute their positional range dependently
- or independently.
- cliponaxis
- Determines whether or not markers and text nodes are
- clipped about the subplot axes. To show markers and
- text nodes above axis lines and tick labels, make sure
- to set `xaxis.layer` and `yaxis.layer` to *below
- traces*.
connectgaps
Determines whether or not gaps (i.e. {nan} or missing
values) in the provided data arrays are connected.
@@ -13369,61 +14736,15 @@ def add_scatter(
customdatasrc
Sets the source reference on Chart Studio Cloud for
`customdata`.
- dx
- Sets the x coordinate step. See `x0` for more info.
- dy
- Sets the y coordinate step. See `y0` for more info.
error_x
- :class:`plotly.graph_objects.scatter.ErrorX` instance
+ :class:`plotly.graph_objects.scatter3d.ErrorX` instance
or dict with compatible properties
error_y
- :class:`plotly.graph_objects.scatter.ErrorY` instance
+ :class:`plotly.graph_objects.scatter3d.ErrorY` instance
+ or dict with compatible properties
+ error_z
+ :class:`plotly.graph_objects.scatter3d.ErrorZ` instance
or dict with compatible properties
- fill
- Sets the area to fill with a solid color. Defaults to
- "none" unless this trace is stacked, then it gets
- "tonexty" ("tonextx") if `orientation` is "v" ("h") Use
- with `fillcolor` if not "none". "tozerox" and "tozeroy"
- fill to x=0 and y=0 respectively. "tonextx" and
- "tonexty" fill between the endpoints of this trace and
- the endpoints of the trace before it, connecting those
- endpoints with straight lines (to make a stacked area
- graph); if there is no trace before it, they behave
- like "tozerox" and "tozeroy". "toself" connects the
- endpoints of the trace (or each segment of the trace if
- it has gaps) into a closed shape. "tonext" fills the
- space between two traces if one completely encloses the
- other (eg consecutive contour lines), and behaves like
- "toself" if there is no trace before it. "tonext"
- should not be used if one trace does not enclose the
- other. Traces in a `stackgroup` will only fill to (or
- be filled to) other traces in the same group. With
- multiple `stackgroup`s or some traces stacked and some
- not, if fill-linked traces are not already consecutive,
- the later ones will be pushed down in the drawing
- order.
- fillcolor
- Sets the fill color. Defaults to a half-transparent
- variant of the line color, marker color, or marker line
- color, whichever is available. If fillgradient is
- specified, fillcolor is ignored except for setting the
- background color of the hover label, if any.
- fillgradient
- Sets a fill gradient. If not specified, the fillcolor
- is used instead.
- fillpattern
- Sets the pattern within the marker.
- groupnorm
- Only relevant when `stackgroup` is used, and only the
- first `groupnorm` found in the `stackgroup` will be
- used - including if `visible` is "legendonly" but not
- if it is `false`. Sets the normalization for the sum of
- this `stackgroup`. With "fraction", the value of each
- trace at each location is divided by the sum of all
- trace values at that location. "percent" is the same
- but multiplied by 100 to show percentages. If there are
- multiple subplots, or multiple `stackgroup`s on one
- subplot, each will be normalized within its own set.
hoverinfo
Determines which trace information appear on hover. If
`none` or `skip` are set, no information is displayed
@@ -13433,14 +14754,8 @@ def add_scatter(
Sets the source reference on Chart Studio Cloud for
`hoverinfo`.
hoverlabel
- :class:`plotly.graph_objects.scatter.Hoverlabel`
+ :class:`plotly.graph_objects.scatter3d.Hoverlabel`
instance or dict with compatible properties
- hoveron
- Do the hover effects highlight individual points
- (markers or line points) or do they highlight filled
- regions? If the fill is "toself" or "tonext" and there
- are no markers or text, then the default is "fills",
- otherwise it is "points".
hovertemplate
Template string used for rendering the information that
appear on hover box. Note that this will override
@@ -13473,10 +14788,10 @@ def add_scatter(
Sets the source reference on Chart Studio Cloud for
`hovertemplate`.
hovertext
- Sets hover text elements associated with each (x,y)
- pair. If a single string, the same string appears over
- all the data points. If an array of string, the items
- are mapped in order to the this trace's (x,y)
+ Sets text elements associated with each (x,y,z)
+ triplet. If a single string, the same string appears
+ over all the data points. If an array of string, the
+ items are mapped in order to the this trace's (x,y,z)
coordinates. To be seen, trace `hoverinfo` must contain
a "text" flag.
hovertextsrc
@@ -13500,8 +14815,8 @@ def add_scatter(
part of the same legend group hide/show at the same
time when toggling legend items.
legendgrouptitle
- :class:`plotly.graph_objects.scatter.Legendgrouptitle`
- instance or dict with compatible properties
+ :class:`plotly.graph_objects.scatter3d.Legendgrouptitle
+ ` instance or dict with compatible properties
legendrank
Sets the legend rank for this trace. Items and groups
with smaller ranks are presented on top/left side while
@@ -13517,10 +14832,10 @@ def add_scatter(
Sets the width (in px or fraction) of the legend for
this trace.
line
- :class:`plotly.graph_objects.scatter.Line` instance or
- dict with compatible properties
+ :class:`plotly.graph_objects.scatter3d.Line` instance
+ or dict with compatible properties
marker
- :class:`plotly.graph_objects.scatter.Marker` instance
+ :class:`plotly.graph_objects.scatter3d.Marker` instance
or dict with compatible properties
meta
Assigns extra meta information associated with this
@@ -13548,69 +14863,37 @@ def add_scatter(
name
Sets the trace name. The trace name appears as the
legend item and on hover.
- offsetgroup
- Set several traces linked to the same position axis or
- matching axes to the same offsetgroup where bars of the
- same position coordinate will line up.
opacity
Sets the opacity of the trace.
- orientation
- Only relevant in the following cases: 1. when
- `scattermode` is set to "group". 2. when `stackgroup`
- is used, and only the first `orientation` found in the
- `stackgroup` will be used - including if `visible` is
- "legendonly" but not if it is `false`. Sets the
- stacking direction. With "v" ("h"), the y (x) values of
- subsequent traces are added. Also affects the default
- value of `fill`.
- selected
- :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.
- Note that an empty array means an empty selection where
- the `unselected` are turned on for all points, whereas,
- any other non-array values means no selection all where
- the `selected` and `unselected` styles have no effect.
+ projection
+ :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),
+ the (x,y,z) coordinates refer to `layout.scene`. If
+ "scene2", the (x,y,z) coordinates refer to
+ `layout.scene2`, and so on.
showlegend
Determines whether or not an item corresponding to this
trace is shown in the legend.
- stackgaps
- Only relevant when `stackgroup` is used, and only the
- first `stackgaps` found in the `stackgroup` will be
- used - including if `visible` is "legendonly" but not
- if it is `false`. Determines how we handle locations at
- which other traces in this group have data but this one
- does not. With *infer zero* we insert a zero at these
- locations. With "interpolate" we linearly interpolate
- between existing values, and extrapolate a constant
- beyond the existing values.
- stackgroup
- Set several scatter traces (on the same subplot) to the
- same stackgroup in order to add their y values (or
- their x values if `orientation` is "h"). If blank or
- omitted this trace will not be stacked. Stacking also
- turns `fill` on by default, using "tonexty" ("tonextx")
- if `orientation` is "h" ("v") and sets the default
- `mode` to "lines" irrespective of point count. You can
- only stack on a numeric (linear or log) axis. Traces in
- a `stackgroup` will only fill to (or be filled to)
- other traces in the same group. With multiple
- `stackgroup`s or some traces stacked and some not, if
- fill-linked traces are not already consecutive, the
- later ones will be pushed down in the drawing order.
stream
- :class:`plotly.graph_objects.scatter.Stream` instance
+ :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
+ Delaunay surface about the x, y, z respectively.
+ surfacecolor
+ Sets the surface fill color.
text
- Sets text elements associated with each (x,y) pair. If
- a single string, the same string appears over all the
- data points. If an array of string, the items are
- mapped in order to the this trace's (x,y) coordinates.
- If trace `hoverinfo` contains a "text" flag and
- "hovertext" is not set, these elements will be seen in
- the hover labels.
+ Sets text elements associated with each (x,y,z)
+ triplet. If a single string, the same string appears
+ over all the data points. If an array of string, the
+ items are mapped in order to the this trace's (x,y,z)
+ coordinates. If trace `hoverinfo` contains a "text"
+ flag and "hovertext" is not set, these elements will be
+ seen in the hover labels.
textfont
Sets the text font.
textposition
@@ -13662,10 +14945,7 @@ def add_scatter(
traces before the end of the `data` array, such that
the same trace has a different index, you can still
preserve user-driven changes if you give each trace a
- `uid` that stays with it as it moves.
- unselected
- :class:`plotly.graph_objects.scatter.Unselected`
- instance or dict with compatible properties
+ `uid` that stays with it as it moves.
visible
Determines whether or not this trace is visible. If
"legendonly", the trace is not drawn, but can appear as
@@ -13673,15 +14953,6 @@ def add_scatter(
visible).
x
Sets the x coordinates.
- x0
- Alternate to `x`. Builds a linear space of x
- coordinates. Use with `dx` where `x0` is the starting
- coordinate and `dx` the step.
- xaxis
- Sets a reference between this trace's x coordinates and
- a 2D cartesian x axis. If "x" (the default value), the
- x coordinates refer to `layout.xaxis`. If "x2", the x
- coordinates refer to `layout.xaxis2`, and so on.
xcalendar
Sets the calendar system to use with `x` date data.
xhoverformat
@@ -13697,36 +14968,11 @@ def add_scatter(
09:15:23.456* with tickformat "%H~%M~%S.%2f" would
display *09~15~23.46*By default the values are
formatted using `xaxis.hoverformat`.
- xperiod
- Only relevant when the axis `type` is "date". Sets the
- period positioning in milliseconds or "M