diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 9a9f326b3..868763a97 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -33,10 +33,6 @@ jobs:
- name: Fetch upstream docs
run: make fetch_upstream_files
- - name: Set up Mapbox token
- run: |
- echo "token: ${{ secrets.MAPBOX_TOKEN }}" > _data/mapbox_token.yml
-
- name: Build site
run: |
python front-matter-ci.py _posts
@@ -49,7 +45,6 @@ jobs:
md5sum all_static/css/main.css | cut -d ' ' -f 1 > _data/cache_bust_css.yml
bundle exec jekyll build
cp python/sitemap.xml _site/python/sitemap.xml
- rm _data/mapbox_token.yml
- name: Create Percy snapshots
run: |
diff --git a/_data/display_as.yml b/_data/display_as.yml
index 74d89ff02..4a557b5ca 100644
--- a/_data/display_as.yml
+++ b/_data/display_as.yml
@@ -13,6 +13,9 @@ signal-analysis:
file_settings:
reference: '#fundamentals'
text: Fundamentals
+guide:
+ reference: '#guides'
+ text: Guides
basic:
reference: '#basic-charts'
text: Basic
diff --git a/_data/display_as_py_r_js.yml b/_data/display_as_py_r_js.yml
index d01a415a9..f9fae4381 100644
--- a/_data/display_as_py_r_js.yml
+++ b/_data/display_as_py_r_js.yml
@@ -13,6 +13,9 @@ signal-analysis:
file_settings:
reference: 'plotly-fundamentals'
text: Fundamentals
+guide:
+ reference: 'guides'
+ text: Guides
basic:
reference: 'basic-charts'
text: Basic Charts
diff --git a/_data/jsversion.json b/_data/jsversion.json
index ed344f47d..fc7c93fcc 100644
--- a/_data/jsversion.json
+++ b/_data/jsversion.json
@@ -1,3 +1,3 @@
{
- "version": "3.6.0"
+ "version": "4.0.0-rc.0"
}
\ No newline at end of file
diff --git a/_data/make_ref_pages.py b/_data/make_ref_pages.py
index ee5e118ab..bbf92b3b4 100644
--- a/_data/make_ref_pages.py
+++ b/_data/make_ref_pages.py
@@ -3,13 +3,19 @@
schema = json.load(open("plotschema.json"))
-for upperlang in ["Python", "JavaScript", "MATLAB", "R", "Julia", "F#"]:
+# Only Python and JavaScript are regenerated. The MATLAB, R, Julia, and F# reference
+# pages are frozen at whatever schema they were last built from: those languages are no
+# longer maintained, and their pages load pinned older plotly.js bundles (R/ggplot2 on
+# 1.58.4, Julia/MATLAB on 2.35.3 — see _includes/layouts/head.html), so regenerating them
+# from a current schema would document attributes their bundles don't have and drop ones
+# they do. Their existing files under _posts/reference_pages// are left untouched.
+for upperlang in ["Python", "JavaScript"]:
lang = upperlang.lower()
lang = "fsharp" if lang == "f#" else lang
lang = "csharp" if lang == "c#" else lang
langcode = "plotly_js" if lang == "javascript" else lang
for attr in [
- "xaxis", "yaxis", "coloraxis", "scene", "polar", "ternary", "smith", "geo", "mapbox",
+ "xaxis", "yaxis", "coloraxis", "scene", "polar", "ternary", "smith", "geo", "map",
"sliders", "updatemenus", "annotations", "shapes", "images","selections", "global"
]:
fullattr = "layout" + ("." + attr if attr != "global" else "")
diff --git a/_data/orderings.json b/_data/orderings.json
index bbc9c956a..d8312694b 100644
--- a/_data/orderings.json
+++ b/_data/orderings.json
@@ -50,7 +50,6 @@
"scene",
"geo",
"map",
- "mapbox",
"polar",
"smith",
@@ -63,8 +62,6 @@
"sliders",
"selections",
- "hidesources",
-
"_deprecated",
"radialaxis",
"angularaxis",
@@ -75,7 +72,7 @@
"traces": [
"scatter", "scattergl",
"bar", "pie", "heatmap", "heatmapgl","image",
- "contour", "table",
+ "contour", "quiver", "table",
"box", "violin", "histogram", "histogram2d", "histogram2dcontour",
@@ -83,7 +80,7 @@
"scatter3d", "surface", "mesh3d", "cone", "streamtube", "volume", "isosurface",
- "scattergeo", "choropleth", "scattermap", "scattermapbox", "choroplethmap", "choroplethmapbox", "densitymap", "densitymapbox",
+ "scattergeo", "choropleth", "scattermap", "choroplethmap", "densitymap",
"scatterpolar", "scatterpolargl", "barpolar", "scatterternary", "scattersmith", "sunburst", "treemap", "icicle",
diff --git a/_data/plotschema.json b/_data/plotschema.json
index 47745dbbd..f4e5d9a66 100644
--- a/_data/plotschema.json
+++ b/_data/plotschema.json
@@ -141,7 +141,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, mapbox and map) 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 and map) and on-legend double clicks.",
"dflt": 300,
"min": 0,
"valType": "number"
@@ -221,12 +221,6 @@
"min": 0,
"valType": "number"
},
- "linkText": {
- "description": "Sets the text appearing in the `showLink` link.",
- "dflt": "Edit chart",
- "noBlank": true,
- "valType": "string"
- },
"locale": {
"description": "Which localization should we use? Should be a string like 'en' or 'en-US'.",
"dflt": "en-US",
@@ -244,11 +238,6 @@
"min": 0,
"valType": "integer"
},
- "mapboxAccessToken": {
- "description": "Mapbox access token (required to plot mapbox trace types) If using an Mapbox Atlas server, set this option to '' so that plotly.js won't attempt to authenticate to the public Mapbox server.",
- "dflt": null,
- "valType": "string"
- },
"modeBarButtons": {
"description": "Define fully custom mode bar buttons as nested array, where the outer arrays represents button groups, and the inner arrays have buttons config objects or names of default buttons See ./components/modebar/buttons.js for more info.",
"dflt": false,
@@ -279,8 +268,8 @@
"valType": "number"
},
"plotlyServerURL": {
- "description": "When set it determines base URL for the 'Edit in Chart Studio' `showEditInChartStudio`/`showSendToCloud` mode bar button and the showLink/sendData on-graph link. To enable sending your data to Chart Studio Cloud, you need to set both `plotlyServerURL` to 'https://chart-studio.plotly.com' and also set `showSendToCloud` to true.",
- "dflt": "",
+ "description": "Sets the URL for the `sendChartToCloud` modebar button. When clicked, the button will send the chart data to this URL.",
+ "dflt": "https://cloud.plotly.com/newchart",
"valType": "string"
},
"queueLength": {
@@ -295,7 +284,7 @@
"valType": "boolean"
},
"scrollZoom": {
- "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.",
+ "description": "Determines whether mouse wheel or two-finger scroll zooms is enable. Turned on by default for gl3d, geo 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,
@@ -305,16 +294,10 @@
"cartesian",
"gl3d",
"geo",
- "mapbox",
"map"
],
"valType": "flaglist"
},
- "sendData": {
- "description": "If *showLink* is true, does it contain data just link to a Chart Studio Cloud file?",
- "dflt": true,
- "valType": "boolean"
- },
"setBackground": {
"description": "Set function to add the background color (i.e. `layout.paper_color`) to a different container. This function take the graph div as first argument and the current background color as second argument. Alternatively, set to string *opaque* to ensure there is white behind it.",
"dflt": "transparent",
@@ -330,26 +313,11 @@
"dflt": true,
"valType": "boolean"
},
- "showEditInChartStudio": {
- "description": "Same as `showSendToCloud`, but use a pencil icon instead of a floppy-disk. Note that if both `showSendToCloud` and `showEditInChartStudio` are turned, only `showEditInChartStudio` will be honored.",
- "dflt": false,
- "valType": "boolean"
- },
- "showLink": {
- "description": "Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs. Use with `sendData` and `linkText`.",
- "dflt": false,
- "valType": "boolean"
- },
"showSendToCloud": {
- "description": "Should we include a ModeBar button, labeled \"Edit in Chart Studio\", that sends this chart to chart-studio.plotly.com (formerly plot.ly) or another plotly server as specified by `plotlyServerURL` for editing, export, etc? Prior to version 1.43.0 this button was included by default, now it is opt-in using this flag. Note that this button can (depending on `plotlyServerURL` being set) send your data to an external server. However that server does not persist your data until you arrive at the Chart Studio and explicitly click \"Save\".",
- "dflt": false,
+ "description": "Should we include a modebar button that sends this chart to a URL specified by `plotlyServerURL`, for sharing the chart with others? Note that this button will (after a confirmation step) send chart data to an external server.",
+ "dflt": true,
"valType": "boolean"
},
- "showSources": {
- "description": "Adds a source-displaying function to show sources on the resulting graphs.",
- "dflt": false,
- "valType": "any"
- },
"showTips": {
"description": "Determines whether or not tips are shown while interacting with the resulting graphs.",
"dflt": true,
@@ -372,7 +340,7 @@
"valType": "string"
},
"typesetMath": {
- "description": "Determines whether math should be typeset or not, when MathJax (either v2 or v3) is present on the page.",
+ "description": "Determines whether math should be typeset or not, when MathJax (either v3 or v4) is present on the page.",
"dflt": true,
"valType": "boolean"
},
@@ -459,7 +427,7 @@
"requiredOpts": []
},
"color": {
- "description": "A string describing color. Supported formats: - hex (e.g. '#d3d3d3') - rgb (e.g. 'rgb(255, 0, 0)') - rgba (e.g. 'rgb(255, 0, 0, 0.5)') - hsl (e.g. 'hsl(0, 100%, 50%)') - hsv (e.g. 'hsv(0, 100%, 100%)') - named colors (full list: http://www.w3.org/TR/css3-color/#svg-color)",
+ "description": "A string describing color. Supported formats: - hex (e.g. '#d3d3d3', '#d3d3d3aa') - rgb (e.g. 'rgb(255, 0, 0)', 'rgb(255 0 0)') - rgba (e.g. 'rgba(255, 0, 0, 0.5)', 'rgba(255 0 0 / 0.5)') - hsl (e.g. 'hsl(0, 100%, 50%)') - hsla (e.g. 'hsla(0, 100%, 50%, 0.5)') - hwb (e.g. 'hwb(0, 0%, 0%)') - named colors (full list: http://www.w3.org/TR/css3-color/#svg-color)",
"otherOpts": [
"dflt",
"arrayOk"
@@ -499,7 +467,7 @@
]
},
"flaglist": {
- "description": "A string representing a combination of flags (order does not matter here). Combine any of the available `flags` with *+*. (e.g. ('lines+markers')). Values in `extras` cannot be combined.",
+ "description": "A string representing a combination of flags (flag order does not affect the output). Combine any of the available `flags` with *+*. (e.g. ('lines+markers')). Values in `extras` cannot be combined.",
"otherOpts": [
"dflt",
"extras",
@@ -2363,22 +2331,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_coloraxes(colorbar_ticktext=<VALUE>)"
},
- "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",
"magic_underscores": "fig.update_coloraxes(colorbar_tickvals=<VALUE>)"
},
- "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,
@@ -2490,7 +2448,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -2583,7 +2541,7 @@
"magic_underscores": "fig.update_coloraxes(colorbar=dict(...))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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": {
@@ -2627,11 +2585,6 @@
"valType": "string",
"magic_underscores": "fig.update_layout(modebar_add=<VALUE>)"
},
- "addsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `add`.",
- "editType": "none",
- "valType": "string"
- },
"bgcolor": {
"description": "Sets the background color of the modebar.",
"editType": "modebar",
@@ -2658,17 +2611,12 @@
},
"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*, *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*.",
+ "description": "Determines which predefined modebar buttons to remove. Similar to `config.modeBarButtonsToRemove` option. This may include *autoScale2d*, *autoscale*, *hoverCompareCartesian*, *hovercompare*, *lasso*, *lasso2d*, *orbitRotation*, *orbitrotation*, *pan*, *pan2d*, *pan3d*, *reset*, *resetCameraDefault3d*, *resetCameraLastSave3d*, *resetGeo*, *resetSankeyGroup*, *resetScale2d*, *resetViewMap*, *resetViews*, *resetcameradefault*, *resetcameralastsave*, *resetsankeygroup*, *resetscale*, *resetview*, *resetviews*, *select*, *select2d*, *sendChartToCloud*, *sendcharttocloud*, *tableRotation*, *tablerotation*, *toImage*, *toggleHover*, *toggleSpikelines*, *togglehover*, *togglespikelines*, *toimage*, *zoom*, *zoom2d*, *zoom3d*, *zoomIn2d*, *zoomInGeo*, *zoomInMap*, *zoomOut2d*, *zoomOutGeo*, *zoomOutMap*, *zoomin*, *zoomout*.",
"dflt": "",
"editType": "modebar",
"valType": "string",
"magic_underscores": "fig.update_layout(modebar_remove=<VALUE>)"
},
- "removesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `remove`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"uirevision": {
"description": "Controls persistence of user-driven changes related to the modebar, including `hovermode`, `dragmode`, and `showspikes` at both the root level and inside subplots. Defaults to `layout.uirevision`.",
@@ -3217,11 +3165,6 @@
"valType": "any",
"magic_underscores": "fig.update_layout(meta=<VALUE>)"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
"computed": {
"description": "Placeholder for exporting automargin-impacting values namely `margin.t`, `margin.b`, `margin.l` and `margin.r` in *full-json* mode.",
"editType": "none",
@@ -3524,7 +3467,7 @@
"editType": "plot",
"include": {
"arrayOk": true,
- "description": "Ensure this value is included in autorange.",
+ "description": "Extends the autorange to include this value or array of values, even when they fall outside the data range. Has no effect on endpoints set by `autorangeoptions.minallowed` or `autorangeoptions.maxallowed`. Subject to `autorangeoptions.clipmin` and `autorangeoptions.clipmax`.",
"editType": "plot",
"impliedEdits": {
"magic_underscores": "fig.update_xaxes(autorangeoptions_include_impliedEdits=<VALUE>)"
@@ -3532,11 +3475,6 @@
"valType": "any",
"magic_underscores": "fig.update_xaxes(autorangeoptions_include=<VALUE>)"
},
- "includesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `include`.",
- "editType": "none",
- "valType": "string"
- },
"maxallowed": {
"description": "Use this value exactly as autorange maximum.",
"editType": "plot",
@@ -3615,11 +3553,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_xaxes(categoryarray=<VALUE>)"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean, geometric mean or median of all the values.",
"dflt": "trace",
@@ -3985,11 +3918,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_xaxes(minor_tickvals=<VALUE>)"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
"tickwidth": {
"description": "Sets the tick width (in px).",
"editType": "ticks",
@@ -4666,7 +4594,7 @@
"magic_underscores": "fig.update_xaxes(spikedash=<VALUE>)"
},
"spikemode": {
- "description": "Determines the drawing mode for the spike line If *toaxis*, the line is drawn from the data point to the axis the series is plotted on. If *across*, the line is drawn across the entire plot area, and supercedes *toaxis*. If *marker*, then a marker dot is drawn on the axis the series is plotted on",
+ "description": "Determines the drawing mode for the spike line If *toaxis*, the line is drawn from the data point to the axis the series is plotted on. If *across*, the line is drawn across the entire plot area, and supercedes *toaxis*. If *marker*, then a marker dot is drawn on the axis the series is plotted on",
"dflt": "toaxis",
"editType": "none",
"flags": [
@@ -4880,11 +4808,6 @@
"valType": "integer",
"magic_underscores": "fig.update_xaxes(ticklabelindex=<VALUE>)"
},
- "ticklabelindexsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticklabelindex`.",
- "editType": "none",
- "valType": "string"
- },
"ticklabelmode": {
"description": "Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of `type` *date* When set to *period*, tick labels are drawn in the middle of the period between ticks.",
"dflt": "instant",
@@ -4957,7 +4880,7 @@
"magic_underscores": "fig.update_xaxes(ticklen=<VALUE>)"
},
"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). If *sync*, the number of ticks will sync with the overlayed axis set by `overlaying` property.",
+ "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). If *sync*, the number of ticks will sync with the overlayed axis set by `overlaying` property. When no other tick info is provided, overlaying (non-categorical) axes default to *sync*, while other axes default to *auto*.",
"editType": "ticks",
"impliedEdits": {
"magic_underscores": "fig.update_xaxes(tickmode_impliedEdits=<VALUE>)"
@@ -5013,22 +4936,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_xaxes(ticktext=<VALUE>)"
},
- "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": "ticks",
"valType": "data_array",
"magic_underscores": "fig.update_xaxes(tickvals=<VALUE>)"
},
- "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,
@@ -5300,7 +5213,7 @@
"editType": "plot",
"include": {
"arrayOk": true,
- "description": "Ensure this value is included in autorange.",
+ "description": "Extends the autorange to include this value or array of values, even when they fall outside the data range. Has no effect on endpoints set by `autorangeoptions.minallowed` or `autorangeoptions.maxallowed`. Subject to `autorangeoptions.clipmin` and `autorangeoptions.clipmax`.",
"editType": "plot",
"impliedEdits": {
"magic_underscores": "fig.update_yaxes(autorangeoptions_include_impliedEdits=<VALUE>)"
@@ -5308,11 +5221,6 @@
"valType": "any",
"magic_underscores": "fig.update_yaxes(autorangeoptions_include=<VALUE>)"
},
- "includesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `include`.",
- "editType": "none",
- "valType": "string"
- },
"maxallowed": {
"description": "Use this value exactly as autorange maximum.",
"editType": "plot",
@@ -5398,11 +5306,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_yaxes(categoryarray=<VALUE>)"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean, geometric mean or median of all the values.",
"dflt": "trace",
@@ -5768,11 +5671,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_yaxes(minor_tickvals=<VALUE>)"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
"tickwidth": {
"description": "Sets the tick width (in px).",
"editType": "ticks",
@@ -6099,7 +5997,7 @@
"magic_underscores": "fig.update_yaxes(spikedash=<VALUE>)"
},
"spikemode": {
- "description": "Determines the drawing mode for the spike line If *toaxis*, the line is drawn from the data point to the axis the series is plotted on. If *across*, the line is drawn across the entire plot area, and supercedes *toaxis*. If *marker*, then a marker dot is drawn on the axis the series is plotted on",
+ "description": "Determines the drawing mode for the spike line If *toaxis*, the line is drawn from the data point to the axis the series is plotted on. If *across*, the line is drawn across the entire plot area, and supercedes *toaxis*. If *marker*, then a marker dot is drawn on the axis the series is plotted on",
"dflt": "toaxis",
"editType": "none",
"flags": [
@@ -6313,11 +6211,6 @@
"valType": "integer",
"magic_underscores": "fig.update_yaxes(ticklabelindex=<VALUE>)"
},
- "ticklabelindexsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticklabelindex`.",
- "editType": "none",
- "valType": "string"
- },
"ticklabelmode": {
"description": "Determines where tick labels are drawn with respect to their corresponding ticks and grid lines. Only has an effect for axes of `type` *date* When set to *period*, tick labels are drawn in the middle of the period between ticks.",
"dflt": "instant",
@@ -6390,7 +6283,7 @@
"magic_underscores": "fig.update_yaxes(ticklen=<VALUE>)"
},
"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). If *sync*, the number of ticks will sync with the overlayed axis set by `overlaying` property.",
+ "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). If *sync*, the number of ticks will sync with the overlayed axis set by `overlaying` property. When no other tick info is provided, overlaying (non-categorical) axes default to *sync*, while other axes default to *auto*.",
"editType": "ticks",
"impliedEdits": {
"magic_underscores": "fig.update_yaxes(tickmode_impliedEdits=<VALUE>)"
@@ -6446,22 +6339,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_yaxes(ticktext=<VALUE>)"
},
- "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": "ticks",
"valType": "data_array",
"magic_underscores": "fig.update_yaxes(tickvals=<VALUE>)"
},
- "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,
@@ -7097,22 +6980,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_ternaries(aaxis_ticktext=<VALUE>)"
},
- "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": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_ternaries(aaxis_tickvals=<VALUE>)"
},
- "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,
@@ -7674,22 +7547,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_ternaries(baxis_ticktext=<VALUE>)"
},
- "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": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_ternaries(baxis_tickvals=<VALUE>)"
},
- "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,
@@ -8258,22 +8121,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_ternaries(caxis_ticktext=<VALUE>)"
},
- "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": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_ternaries(caxis_tickvals=<VALUE>)"
},
- "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,
@@ -8402,7 +8255,7 @@
},
"domain": {
"column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this ternary subplot .",
+ "description": "If there is a layout grid, use the domain for this column in the grid for this ternary subplot.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -8412,7 +8265,7 @@
"editType": "plot",
"role": "object",
"row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this ternary subplot .",
+ "description": "If there is a layout grid, use the domain for this row in the grid for this ternary subplot.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -9094,7 +8947,7 @@
},
"domain": {
"column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this scene subplot .",
+ "description": "If there is a layout grid, use the domain for this column in the grid for this scene subplot.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -9104,7 +8957,7 @@
"editType": "plot",
"role": "object",
"row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this scene subplot .",
+ "description": "If there is a layout grid, use the domain for this row in the grid for this scene subplot.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -9235,7 +9088,7 @@
"editType": "plot",
"include": {
"arrayOk": true,
- "description": "Ensure this value is included in autorange.",
+ "description": "Extends the autorange to include this value or array of values, even when they fall outside the data range. Has no effect on endpoints set by `autorangeoptions.minallowed` or `autorangeoptions.maxallowed`. Subject to `autorangeoptions.clipmin` and `autorangeoptions.clipmax`.",
"editType": "plot",
"impliedEdits": {
"magic_underscores": "fig.update_scenes(xaxis_autorangeoptions_include_impliedEdits=<VALUE>)"
@@ -9243,11 +9096,6 @@
"valType": "any",
"magic_underscores": "fig.update_scenes(xaxis_autorangeoptions_include=<VALUE>)"
},
- "includesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `include`.",
- "editType": "none",
- "valType": "string"
- },
"maxallowed": {
"description": "Use this value exactly as autorange maximum.",
"editType": "plot",
@@ -9318,11 +9166,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_scenes(xaxis_categoryarray=<VALUE>)"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean, geometric mean or median of all the values.",
"dflt": "trace",
@@ -9856,22 +9699,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_scenes(xaxis_ticktext=<VALUE>)"
},
- "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": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_scenes(xaxis_tickvals=<VALUE>)"
},
- "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,
@@ -10075,7 +9908,7 @@
"editType": "plot",
"include": {
"arrayOk": true,
- "description": "Ensure this value is included in autorange.",
+ "description": "Extends the autorange to include this value or array of values, even when they fall outside the data range. Has no effect on endpoints set by `autorangeoptions.minallowed` or `autorangeoptions.maxallowed`. Subject to `autorangeoptions.clipmin` and `autorangeoptions.clipmax`.",
"editType": "plot",
"impliedEdits": {
"magic_underscores": "fig.update_scenes(yaxis_autorangeoptions_include_impliedEdits=<VALUE>)"
@@ -10083,11 +9916,6 @@
"valType": "any",
"magic_underscores": "fig.update_scenes(yaxis_autorangeoptions_include=<VALUE>)"
},
- "includesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `include`.",
- "editType": "none",
- "valType": "string"
- },
"maxallowed": {
"description": "Use this value exactly as autorange maximum.",
"editType": "plot",
@@ -10158,11 +9986,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_scenes(yaxis_categoryarray=<VALUE>)"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean, geometric mean or median of all the values.",
"dflt": "trace",
@@ -10696,22 +10519,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_scenes(yaxis_ticktext=<VALUE>)"
},
- "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": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_scenes(yaxis_tickvals=<VALUE>)"
},
- "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,
@@ -10915,7 +10728,7 @@
"editType": "plot",
"include": {
"arrayOk": true,
- "description": "Ensure this value is included in autorange.",
+ "description": "Extends the autorange to include this value or array of values, even when they fall outside the data range. Has no effect on endpoints set by `autorangeoptions.minallowed` or `autorangeoptions.maxallowed`. Subject to `autorangeoptions.clipmin` and `autorangeoptions.clipmax`.",
"editType": "plot",
"impliedEdits": {
"magic_underscores": "fig.update_scenes(zaxis_autorangeoptions_include_impliedEdits=<VALUE>)"
@@ -10923,11 +10736,6 @@
"valType": "any",
"magic_underscores": "fig.update_scenes(zaxis_autorangeoptions_include=<VALUE>)"
},
- "includesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `include`.",
- "editType": "none",
- "valType": "string"
- },
"maxallowed": {
"description": "Use this value exactly as autorange maximum.",
"editType": "plot",
@@ -10998,11 +10806,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_scenes(zaxis_categoryarray=<VALUE>)"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean, geometric mean or median of all the values.",
"dflt": "trace",
@@ -11536,22 +11339,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_scenes(zaxis_ticktext=<VALUE>)"
},
- "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": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_scenes(zaxis_tickvals=<VALUE>)"
},
- "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,
@@ -11773,7 +11566,7 @@
},
"domain": {
"column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.",
+ "description": "If there is a layout grid, use the domain for this column in the grid for this geo subplot. Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -11783,7 +11576,7 @@
"editType": "plot",
"role": "object",
"row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this geo subplot . Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.",
+ "description": "If there is a layout grid, use the domain for this row in the grid for this geo subplot. Note that geo subplots are constrained by domain. In general, when `projection.scale` is set to 1. a map will fit either its x or y domain, but not both.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -11842,8 +11635,8 @@
},
"editType": "plot",
"fitbounds": {
- "description": "Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting `fitbounds` leads to `center.lon` and `center.lat` getting auto-filled. On maps with a non-clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, and `projection.rotation.lon` getting auto-filled. On maps with a clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, `projection.rotation.lon`, `projection.rotation.lat`, `lonaxis.range` and `lataxis.range` getting auto-filled. If *locations*, only the trace's visible locations are considered in the `fitbounds` computations. If *geojson*, the entire trace input `geojson` (if provided) is considered in the `fitbounds` computations, Defaults to *false*.",
- "dflt": false,
+ "description": "Determines if this subplot's view settings are auto-computed to fit trace data. On scoped maps, setting `fitbounds` leads to `center.lon` and `center.lat` getting auto-filled. On maps with a non-clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, and `projection.rotation.lon` getting auto-filled. On maps with a clipped projection, setting `fitbounds` leads to `center.lon`, `center.lat`, `projection.rotation.lon`, `projection.rotation.lat`, `lonaxis.range` and `lataxis.range` getting auto-filled. If *locations* (default), only the trace's visible locations are considered in the `fitbounds` computations. If *geojson*, the entire trace input `geojson` (if provided) is considered in the `fitbounds` computations. If *false*, the view settings are used as-is; set this to opt out of auto-fitting.",
+ "dflt": "locations",
"editType": "plot",
"valType": "enumerated",
"values": [
@@ -12041,6 +11834,22 @@
"magic_underscores": "fig.update_geos(projection_distance=<VALUE>)"
},
"editType": "plot",
+ "maxscale": {
+ "description": "Sets the maximum zoom level of the map view, relative to `projection.scale`. A `maxscale` of *2* (200%) prevents the user from zooming in beyond twice the base zoom level. Must be greater than or equal to *0*; has no upper bound. Defaults to *null* for no upper bound on zoom.",
+ "dflt": null,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_geos(projection_maxscale=<VALUE>)"
+ },
+ "minscale": {
+ "description": "Sets the minimum zoom level of the map view, relative to `projection.scale`. A `minscale` of *0.5* (50%) prevents the user from zooming out beyond half the base zoom level. Must be greater than or equal to *0*; has no upper bound. The default of *0* imposes no lower bound on zoom.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_geos(projection_minscale=<VALUE>)"
+ },
"parallels": {
"description": "For conic projection types only. Sets the parallels (tangent, secant) where the cone intersects the sphere.",
"editType": "plot",
@@ -12380,7 +12189,7 @@
},
"domain": {
"column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this map subplot .",
+ "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,
@@ -12390,7 +12199,7 @@
"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 .",
+ "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,
@@ -12448,6 +12257,17 @@
"magic_underscores": "fig.update_layout(map_domain=dict(...))"
},
"editType": "plot",
+ "fitbounds": {
+ "description": "Determines if this subplot's view settings are auto-computed to fit trace data. If *locations* (default), the view is auto-fit to the lon/lat coordinates of the visible trace data. If *false*, the view settings are used as-is; set this to opt out of auto-fitting. If `fitbounds` is enabled but a user provides `center` or `zoom`, auto-fit will be skipped.",
+ "dflt": "locations",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ false,
+ "locations"
+ ],
+ "magic_underscores": "fig.update_layout(map_fitbounds=<VALUE>)"
+ },
"layers": {
"items": {
"layer": {
@@ -12494,11 +12314,6 @@
"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": {
@@ -12737,432 +12552,6 @@
},
"magic_underscores": "fig.update_layout(map=dict(...))"
},
- "mapbox": {
- "_arrayAttrRegexps": [
- {}
- ],
- "_isSubplotObj": true,
- "accesstoken": {
- "description": "Sets the mapbox access token to be used for this mapbox map. Alternatively, the mapbox access token can be set in the configuration options under `mapboxAccessToken`. Note that accessToken are only required when `style` (e.g with values : basic, streets, outdoors, light, dark, satellite, satellite-streets ) and/or a layout layer references the Mapbox server.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_mapboxes(accesstoken=<VALUE>)"
- },
- "bearing": {
- "description": "Sets the bearing angle of the map in degrees counter-clockwise from North (mapbox.bearing).",
- "dflt": 0,
- "editType": "plot",
- "valType": "number",
- "magic_underscores": "fig.update_mapboxes(bearing=<VALUE>)"
- },
- "bounds": {
- "east": {
- "description": "Sets the maximum longitude of the map (in degrees East) if `west`, `south` and `north` are declared.",
- "editType": "plot",
- "valType": "number",
- "magic_underscores": "fig.update_mapboxes(bounds_east=<VALUE>)"
- },
- "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",
- "magic_underscores": "fig.update_mapboxes(bounds_north=<VALUE>)"
- },
- "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",
- "magic_underscores": "fig.update_mapboxes(bounds_south=<VALUE>)"
- },
- "west": {
- "description": "Sets the minimum longitude of the map (in degrees East) if `east`, `south` and `north` are declared.",
- "editType": "plot",
- "valType": "number",
- "magic_underscores": "fig.update_mapboxes(bounds_west=<VALUE>)"
- },
- "magic_underscores": "fig.update_mapboxes(bounds=dict(...))"
- },
- "center": {
- "editType": "plot",
- "lat": {
- "description": "Sets the latitude of the center of the map (in degrees North).",
- "dflt": 0,
- "editType": "plot",
- "valType": "number",
- "magic_underscores": "fig.update_mapboxes(center_lat=<VALUE>)"
- },
- "lon": {
- "description": "Sets the longitude of the center of the map (in degrees East).",
- "dflt": 0,
- "editType": "plot",
- "valType": "number",
- "magic_underscores": "fig.update_mapboxes(center_lon=<VALUE>)"
- },
- "role": "object",
- "magic_underscores": "fig.update_mapboxes(center=dict(...))"
- },
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this mapbox subplot .",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_mapboxes(domain_column=<VALUE>)"
- },
- "editType": "plot",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this mapbox subplot .",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_mapboxes(domain_row=<VALUE>)"
- },
- "x": {
- "description": "Sets the horizontal domain of this mapbox 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",
- "magic_underscores": "fig.update_mapboxes(domain_x=list(...))"
- },
- "y": {
- "description": "Sets the vertical domain of this mapbox 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",
- "magic_underscores": "fig.update_mapboxes(domain_y=list(...))"
- },
- "magic_underscores": "fig.update_mapboxes(domain=dict(...))"
- },
- "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 (mapbox.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 (mapbox.layer.paint.circle-color) If `type` is *line*, color corresponds to the line color (mapbox.layer.paint.line-color) If `type` is *fill*, color corresponds to the fill color (mapbox.layer.paint.fill-color) If `type` is *symbol*, color corresponds to the icon color (mapbox.layer.paint.icon-color)",
- "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 (mapbox.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 (mapbox.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 (mapbox.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 (mapbox.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 (mapbox.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 (mapbox.layer.paint.circle-opacity) If `type` is *line*, opacity corresponds to the line opacity (mapbox.layer.paint.line-opacity) If `type` is *fill*, opacity corresponds to the fill opacity (mapbox.layer.paint.fill-opacity) If `type` is *symbol*, opacity corresponds to the icon/text opacity (mapbox.layer.paint.text-opacity)",
- "dflt": 1,
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "role": "object",
- "source": {
- "description": "Sets the source data for this layer (mapbox.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 (mapbox.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 (mapbox.layer.layout.icon-image). Full list: https://www.mapbox.com/maki-icons/",
- "dflt": "marker",
- "editType": "plot",
- "valType": "string"
- },
- "iconsize": {
- "description": "Sets the symbol icon size (mapbox.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 (mapbox.layer.layout.symbol-placement). If `placement` is *point*, the label is placed where the geometry is located If `placement` is *line*, the label is placed along the line of the geometry If `placement` is *line-center*, the label is placed on the center of the geometry",
- "dflt": "point",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "point",
- "line",
- "line-center"
- ]
- },
- "role": "object",
- "text": {
- "description": "Sets the symbol text (mapbox.layer.layout.text-field).",
- "dflt": "",
- "editType": "plot",
- "valType": "string"
- },
- "textfont": {
- "color": {
- "editType": "plot",
- "valType": "color"
- },
- "description": "Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to *symbol*.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "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",
- "magic_underscores": "fig.update_mapboxes(layers=list(...))"
- },
- "pitch": {
- "description": "Sets the pitch angle of the map (in degrees, where *0* means perpendicular to the surface of the map) (mapbox.pitch).",
- "dflt": 0,
- "editType": "plot",
- "valType": "number",
- "magic_underscores": "fig.update_mapboxes(pitch=<VALUE>)"
- },
- "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.mapbox.layers`. These layers can be defined either explicitly as a Mapbox 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 which do not require any access tokens, or by using a default Mapbox style or custom Mapbox style URL, both of which require a Mapbox access token Note that Mapbox access token can be set in the `accesstoken` attribute or in the `mapboxAccessToken` config option. Mapbox Style objects are of the form described in the Mapbox GL JS documentation available at https://docs.mapbox.com/mapbox-gl-js/style-spec The built-in plotly.js styles objects are: carto-darkmatter, carto-positron, open-street-map, stamen-terrain, stamen-toner, stamen-watercolor, white-bg The built-in Mapbox styles are: basic, streets, outdoors, light, dark, satellite, satellite-streets Mapbox style URLs are of the form: mapbox://mapbox.mapbox--",
- "dflt": "basic",
- "editType": "plot",
- "valType": "any",
- "values": [
- "basic",
- "streets",
- "outdoors",
- "light",
- "dark",
- "satellite",
- "satellite-streets",
- "carto-darkmatter",
- "carto-positron",
- "open-street-map",
- "stamen-terrain",
- "stamen-toner",
- "stamen-watercolor",
- "white-bg"
- ],
- "magic_underscores": "fig.update_mapboxes(style=<VALUE>)"
- },
- "uirevision": {
- "description": "Controls persistence of user-driven changes in the view: `center`, `zoom`, `bearing`, `pitch`. Defaults to `layout.uirevision`.",
- "editType": "none",
- "valType": "any",
- "magic_underscores": "fig.update_mapboxes(uirevision=<VALUE>)"
- },
- "zoom": {
- "description": "Sets the zoom level of the map (mapbox.zoom).",
- "dflt": 1,
- "editType": "plot",
- "valType": "number",
- "magic_underscores": "fig.update_mapboxes(zoom=<VALUE>)"
- },
- "magic_underscores": "fig.update_mapboxes(...)"
- },
"polar": {
"_isSubplotObj": true,
"angularaxis": {
@@ -13183,11 +12572,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_polars(angularaxis_categoryarray=<VALUE>)"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean, geometric mean or median of all the values.",
"dflt": "trace",
@@ -13688,22 +13072,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_polars(angularaxis_ticktext=<VALUE>)"
},
- "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": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_polars(angularaxis_tickvals=<VALUE>)"
},
- "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,
@@ -13749,7 +13123,7 @@
},
"domain": {
"column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this polar subplot .",
+ "description": "If there is a layout grid, use the domain for this column in the grid for this polar subplot.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -13759,7 +13133,7 @@
"editType": "plot",
"role": "object",
"row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this polar subplot .",
+ "description": "If there is a layout grid, use the domain for this row in the grid for this polar subplot.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -13885,7 +13259,7 @@
"editType": "plot",
"include": {
"arrayOk": true,
- "description": "Ensure this value is included in autorange.",
+ "description": "Extends the autorange to include this value or array of values, even when they fall outside the data range. Has no effect on endpoints set by `autorangeoptions.minallowed` or `autorangeoptions.maxallowed`. Subject to `autorangeoptions.clipmin` and `autorangeoptions.clipmax`.",
"editType": "plot",
"impliedEdits": {
"magic_underscores": "fig.update_polars(radialaxis_autorangeoptions_include_impliedEdits=<VALUE>)"
@@ -13893,11 +13267,6 @@
"valType": "any",
"magic_underscores": "fig.update_polars(radialaxis_autorangeoptions_include=<VALUE>)"
},
- "includesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `include`.",
- "editType": "none",
- "valType": "string"
- },
"maxallowed": {
"description": "Use this value exactly as autorange maximum.",
"editType": "plot",
@@ -13976,11 +13345,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_polars(radialaxis_categoryarray=<VALUE>)"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`. Set `categoryorder` to *total ascending* or *total descending* if order should be determined by the numerical order of the values. Similarly, the order can be determined by the min, max, sum, mean, geometric mean or median of all the values.",
"dflt": "trace",
@@ -14515,22 +13879,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_polars(radialaxis_ticktext=<VALUE>)"
},
- "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": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_polars(radialaxis_tickvals=<VALUE>)"
},
- "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,
@@ -14720,7 +14074,7 @@
},
"domain": {
"column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this smith subplot .",
+ "description": "If there is a layout grid, use the domain for this column in the grid for this smith subplot.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -14730,7 +14084,7 @@
"editType": "plot",
"role": "object",
"row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this smith subplot .",
+ "description": "If there is a layout grid, use the domain for this row in the grid for this smith subplot.",
"dflt": 0,
"editType": "plot",
"min": 0,
@@ -15067,11 +14421,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_smiths(imaginaryaxis_tickvals=<VALUE>)"
},
- "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": 2,
@@ -15393,11 +14742,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_smiths(realaxis_tickvals=<VALUE>)"
},
- "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": 2,
@@ -15484,7 +14828,7 @@
"magic_underscores": "fig.update_annotations(ax=<VALUE>)"
},
"axref": {
- "description": "Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. In order for absolute positioning of the arrow to work, *axref* must be exactly the same as *xref*, otherwise *axref* will revert to *pixel* (explained next). For relative positioning, *axref* can be set to *pixel*, in which case the *ax* value is specified in pixels relative to *x*. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.",
+ "description": "Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. In order for absolute positioning of the arrow to work, *axref* must be exactly the same as *xref*, otherwise *axref* will revert to *pixel* (explained next). For relative positioning, *axref* can be set to *pixel*, in which case the *ax* value is specified in pixels relative to *x*. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.",
"dflt": "pixel",
"editType": "calc",
"valType": "enumerated",
@@ -15501,7 +14845,7 @@
"magic_underscores": "fig.update_annotations(ay=<VALUE>)"
},
"ayref": {
- "description": "Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. In order for absolute positioning of the arrow to work, *ayref* must be exactly the same as *yref*, otherwise *ayref* will revert to *pixel* (explained next). For relative positioning, *ayref* can be set to *pixel*, in which case the *ay* value is specified in pixels relative to *y*. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.",
+ "description": "Indicates in what coordinates the tail of the annotation (ax,ay) is specified. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. In order for absolute positioning of the arrow to work, *ayref* must be exactly the same as *yref*, otherwise *ayref* will revert to *pixel* (explained next). For relative positioning, *ayref* can be set to *pixel*, in which case the *ay* value is specified in pixels relative to *y*. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.",
"dflt": "pixel",
"editType": "calc",
"valType": "enumerated",
@@ -15917,7 +15261,7 @@
"magic_underscores": "fig.update_annotations(xclick=<VALUE>)"
},
"xref": {
- "description": "Sets the annotation's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.",
+ "description": "Sets the annotation's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.",
"editType": "calc",
"valType": "enumerated",
"values": [
@@ -15959,7 +15303,7 @@
"magic_underscores": "fig.update_annotations(yclick=<VALUE>)"
},
"yref": {
- "description": "Sets the annotation's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
+ "description": "Sets the annotation's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
"editType": "calc",
"valType": "enumerated",
"values": [
@@ -16478,7 +15822,7 @@
},
"xref": {
"arrayOk": true,
- "description": "Sets the shape's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. If an array of axis IDs is provided, each `x` value will refer to the corresponding axis, e.g., ['x', 'x2'] for a rectangle, line, or circle means `x0` uses the `x` axis and `x1` uses the `x2` axis. Path shapes using an array should have one entry for each x coordinate in the string.",
+ "description": "Sets the shape's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. If an array of axis IDs is provided, each `x` value will refer to the corresponding axis, e.g., ['x', 'x2'] for a rectangle, line, or circle means `x0` uses the `x` axis and `x1` uses the `x2` axis. Path shapes using an array should have one entry for each x coordinate in the string.",
"editType": "calc",
"valType": "enumerated",
"values": [
@@ -16487,11 +15831,6 @@
],
"magic_underscores": "fig.update_shapes(xref=<VALUE>)"
},
- "xrefsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `xref`.",
- "editType": "none",
- "valType": "string"
- },
"xsizemode": {
"description": "Sets the shapes's sizing mode along the x axis. If set to *scaled*, `x0`, `x1` and x coordinates within `path` refer to data values on the x axis or a fraction of the plot area's width (`xref` set to *paper*). If set to *pixel*, `xanchor` specifies the x position in terms of data or plot fraction but `x0`, `x1` and x coordinates within `path` are pixels relative to `xanchor`. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction. Note: `xsizemode` *pixel* is not supported when `xref` is an array.",
"dflt": "scaled",
@@ -16541,7 +15880,7 @@
},
"yref": {
"arrayOk": true,
- "description": "Sets the shape's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. If an array of axis IDs is provided, each `y` value will refer to the corresponding axis, e.g., ['y', 'y2'] for a rectangle, line, or circle means `y0` uses the `y` axis and `y1` uses the `y2` axis. Path shapes using an array should have one entry for each y coordinate in the string.",
+ "description": "Sets the shape's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. If an array of axis IDs is provided, each `y` value will refer to the corresponding axis, e.g., ['y', 'y2'] for a rectangle, line, or circle means `y0` uses the `y` axis and `y1` uses the `y2` axis. Path shapes using an array should have one entry for each y coordinate in the string.",
"editType": "calc",
"valType": "enumerated",
"values": [
@@ -16550,11 +15889,6 @@
],
"magic_underscores": "fig.update_shapes(yref=<VALUE>)"
},
- "yrefsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `yref`.",
- "editType": "none",
- "valType": "string"
- },
"ysizemode": {
"description": "Sets the shapes's sizing mode along the y axis. If set to *scaled*, `y0`, `y1` and y coordinates within `path` refer to data values on the y axis or a fraction of the plot area's height (`yref` set to *paper*). If set to *pixel*, `yanchor` specifies the y position in terms of data or plot fraction but `y0`, `y1` and y coordinates within `path` are pixels relative to `yanchor`. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction. Note: `ysizemode` *pixel* is not supported when `yref` is an array.",
"dflt": "scaled",
@@ -17128,7 +16462,7 @@
"magic_underscores": "fig.update_layout_images(xanchor=<VALUE>)"
},
"xref": {
- "description": "Sets the images's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.",
+ "description": "Sets the images's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.",
"dflt": "paper",
"editType": "arraydraw",
"valType": "enumerated",
@@ -17158,7 +16492,7 @@
"magic_underscores": "fig.update_layout_images(yanchor=<VALUE>)"
},
"yref": {
- "description": "Sets the images's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
+ "description": "Sets the images's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
"dflt": "paper",
"editType": "arraydraw",
"valType": "enumerated",
@@ -18097,7 +17431,7 @@
"valType": "any"
},
"xref": {
- "description": "Sets the selection's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.",
+ "description": "Sets the selection's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.",
"editType": "arraydraw",
"valType": "enumerated",
"values": [
@@ -18116,7 +17450,7 @@
"valType": "any"
},
"yref": {
- "description": "Sets the selection's x coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
+ "description": "Sets the selection's x coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
"editType": "arraydraw",
"valType": "enumerated",
"values": [
@@ -18129,13 +17463,6 @@
"role": "object",
"magic_underscores": "fig.update_layout(selections=list(...))"
},
- "hidesources": {
- "description": "Determines whether or not a text link citing the data source is placed at the bottom-right cored of the figure. Has only an effect only on graphs that have been generated via forked graphs from the Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise).",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_layout(hidesources=<VALUE>)"
- },
"editType": "calc",
"magic_underscores": "fig.update_layout(...)"
}
@@ -18346,11 +17673,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scatter'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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,
@@ -18365,11 +17687,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='scatter'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
"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.",
@@ -18393,11 +17710,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='scatter'))"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
"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.",
@@ -18422,11 +17734,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scatter'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"arrayOk": true,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
@@ -18446,11 +17753,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scatter'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
@@ -18466,11 +17768,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scatter'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -18479,14 +17776,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scatter'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -18504,11 +17796,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scatter'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -18524,20 +17811,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scatter'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
"magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='scatter'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
@@ -18550,22 +17832,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scatter'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scatter'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
@@ -18695,11 +17967,6 @@
],
"magic_underscores": "fig.update_traces(marker_angleref=<VALUE>, selector=dict(type='scatter'))"
},
- "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,
@@ -19228,22 +18495,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scatter'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scatter'))"
},
- "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,
@@ -19355,7 +18612,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -19448,7 +18705,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scatter'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -19458,11 +18715,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scatter'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"gradient": {
"color": {
@@ -19472,11 +18724,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_gradient_color=<VALUE>, selector=dict(type='scatter'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"type": {
@@ -19493,11 +18740,6 @@
],
"magic_underscores": "fig.update_traces(marker_gradient_type=<VALUE>, selector=dict(type='scatter'))"
},
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_gradient=dict(...), selector=dict(type='scatter'))"
},
"line": {
@@ -19570,7 +18812,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scatter'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -19580,11 +18822,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scatter'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"dash": {
"arrayOk": true,
"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*).",
@@ -19601,11 +18838,6 @@
],
"magic_underscores": "fig.update_traces(marker_line_dash=<VALUE>, selector=dict(type='scatter'))"
},
- "dashsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `dash`.",
- "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.",
@@ -19624,11 +18856,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scatter'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scatter'))"
},
"maxdisplayed": {
@@ -19649,11 +18876,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scatter'))"
},
- "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,
@@ -19705,11 +18927,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scatter'))"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
- },
"standoff": {
"anim": true,
"arrayOk": true,
@@ -19720,11 +18937,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_standoff=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20221,11 +19433,6 @@
],
"magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scatter'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scatter'))"
},
"line": {
@@ -20238,11 +19445,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(line_backoff=<VALUE>, selector=dict(type='scatter'))"
},
- "backoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
- "editType": "none",
- "valType": "string"
- },
"color": {
"anim": true,
"description": "Sets the line color.",
@@ -20316,11 +19518,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scatter'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"description": "Sets the text font.",
"editType": "calc",
"family": {
@@ -20332,11 +19529,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20353,11 +19545,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='scatter'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -20367,11 +19554,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='scatter'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -20379,11 +19561,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20396,11 +19573,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20415,11 +19587,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20436,11 +19603,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20455,11 +19617,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scatter'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scatter'))"
},
"error_x": {
@@ -20475,16 +19632,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(error_x_arrayminus=<VALUE>, selector=dict(type='scatter'))"
},
- "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 stroke color of the error bars.",
"editType": "style",
@@ -20582,16 +19729,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(error_y_arrayminus=<VALUE>, selector=dict(type='scatter'))"
},
- "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 stroke color of the error bars.",
"editType": "style",
@@ -20842,11 +19979,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(fillpattern_bgcolor=<VALUE>, selector=dict(type='scatter'))"
},
- "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": {
@@ -20856,11 +19988,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(fillpattern_fgcolor=<VALUE>, selector=dict(type='scatter'))"
},
- "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",
@@ -20887,11 +20014,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(fillpattern_path=<VALUE>, selector=dict(type='scatter'))"
},
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shape": {
"arrayOk": true,
@@ -20911,11 +20033,6 @@
],
"magic_underscores": "fig.update_traces(fillpattern_shape=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20925,11 +20042,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(fillpattern_size=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20940,11 +20052,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(fillpattern_solidity=<VALUE>, selector=dict(type='scatter'))"
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(fillpattern=dict(...), selector=dict(type='scatter'))"
},
"hoverlabel": {
@@ -20961,11 +20068,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scatter'))"
},
- "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",
@@ -20973,11 +20075,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -20985,11 +20082,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scatter'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -20998,11 +20090,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scatter'))"
},
- "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": {
@@ -21014,11 +20101,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -21035,11 +20117,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scatter'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -21049,11 +20126,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scatter'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -21061,11 +20133,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -21078,11 +20145,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -21097,11 +20159,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -21118,11 +20175,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scatter'))"
},
- "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.",
@@ -21137,11 +20189,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scatter'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scatter'))"
},
"namelength": {
@@ -21153,11 +20200,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scatter'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -21245,28 +20287,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scatter'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scatter'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scatter'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scatter'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='scatter'))"
},
"categories": [
@@ -21505,22 +20525,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scattergl'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"x": {
"description": "Sets the x coordinates.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
"magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='scattergl'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
"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,
@@ -21541,11 +20551,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='scattergl'))"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
"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,
@@ -21568,11 +20573,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scattergl'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"arrayOk": true,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
@@ -21592,11 +20592,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scattergl'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
@@ -21612,11 +20607,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scattergl'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -21625,14 +20615,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scattergl'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -21650,11 +20635,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scattergl'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -21670,20 +20650,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scattergl'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
"magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='scattergl'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
@@ -21696,22 +20671,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scattergl'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scattergl'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
@@ -21785,11 +20750,6 @@
"valType": "angle",
"magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='scattergl'))"
},
- "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,
@@ -22317,22 +21277,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scattergl'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scattergl'))"
},
- "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,
@@ -22444,7 +21394,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "calc",
"valType": "enumerated",
"values": [
@@ -22537,7 +21487,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scattergl'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -22547,11 +21497,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scattergl'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"line": {
"autocolorscale": {
@@ -22622,7 +21567,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scattergl'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -22632,11 +21577,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -22654,11 +21594,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scattergl'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scattergl'))"
},
"opacity": {
@@ -22670,11 +21605,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scattergl'))"
},
- "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,
@@ -22725,11 +21655,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23226,11 +22151,6 @@
],
"magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scattergl'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scattergl'))"
},
"line": {
@@ -23288,11 +22208,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scattergl'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"description": "Sets the text font.",
"editType": "calc",
"family": {
@@ -23304,11 +22219,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scattergl'))"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"size": {
"arrayOk": true,
@@ -23317,11 +22227,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23334,11 +22239,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23351,11 +22251,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23368,11 +22263,6 @@
],
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scattergl'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scattergl'))"
},
"error_x": {
@@ -23388,16 +22278,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(error_x_arrayminus=<VALUE>, selector=dict(type='scattergl'))"
},
- "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 stroke color of the error bars.",
"editType": "calc",
@@ -23495,16 +22375,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(error_y_arrayminus=<VALUE>, selector=dict(type='scattergl'))"
},
- "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 stroke color of the error bars.",
"editType": "calc",
@@ -23717,11 +22587,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scattergl'))"
},
- "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",
@@ -23729,11 +22594,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23741,11 +22601,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scattergl'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -23754,11 +22609,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scattergl'))"
},
- "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": {
@@ -23770,11 +22620,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23791,11 +22636,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scattergl'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -23805,11 +22645,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scattergl'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -23817,11 +22652,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23834,11 +22664,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23853,11 +22678,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23874,11 +22694,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scattergl'))"
},
- "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.",
@@ -23893,11 +22708,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scattergl'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scattergl'))"
},
"namelength": {
@@ -23909,11 +22719,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scattergl'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -23980,28 +22785,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scattergl'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scattergl'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scattergl'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scattergl'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='scattergl'))"
},
"categories": [
@@ -24210,11 +22993,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='bar'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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,
@@ -24229,11 +23007,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='bar'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
"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.",
@@ -24257,11 +23030,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='bar'))"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
"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.",
@@ -24286,11 +23054,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(base=<VALUE>, selector=dict(type='bar'))"
},
- "basesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `base`.",
- "editType": "none",
- "valType": "string"
- },
"width": {
"arrayOk": true,
"description": "Sets the bar width (in position axis units).",
@@ -24300,11 +23063,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='bar'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"offset": {
"arrayOk": true,
"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.",
@@ -24313,11 +23071,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(offset=<VALUE>, selector=dict(type='bar'))"
},
- "offsetsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `offset`.",
- "editType": "none",
- "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.",
@@ -24326,11 +23079,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='bar'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"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.",
@@ -24345,11 +23093,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='bar'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `value` and `label`.",
@@ -24365,11 +23108,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='bar'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -24378,14 +23116,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='bar'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -24403,11 +23136,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='bar'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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 ``.",
@@ -24423,20 +23151,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='bar'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
"magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='bar'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
@@ -24449,22 +23172,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='bar'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='bar'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
@@ -25081,22 +23794,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='bar'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='bar'))"
},
- "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,
@@ -25208,7 +23911,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -25301,7 +24004,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='bar'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -25311,11 +24014,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='bar'))"
},
- "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",
@@ -25392,7 +24090,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='bar'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -25402,11 +24100,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -25426,11 +24119,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='bar'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='bar'))"
},
"opacity": {
@@ -25443,11 +24131,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='bar'))"
},
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "editType": "none",
- "valType": "string"
- },
"pattern": {
"bgcolor": {
"arrayOk": true,
@@ -25456,11 +24139,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='bar'))"
},
- "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": {
@@ -25470,11 +24148,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='bar'))"
},
- "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",
@@ -25501,11 +24174,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='bar'))"
},
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shape": {
"arrayOk": true,
@@ -25525,11 +24193,6 @@
],
"magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -25539,11 +24202,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -25554,11 +24212,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='bar'))"
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='bar'))"
},
"reversescale": {
@@ -25592,11 +24245,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='bar'))"
},
- "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": {
@@ -25608,11 +24256,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -25629,11 +24272,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='bar'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -25643,11 +24281,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='bar'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -25655,11 +24288,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -25672,11 +24300,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -25691,11 +24314,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -25712,11 +24330,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -25731,11 +24344,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='bar'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='bar'))"
},
"error_x": {
@@ -25751,16 +24359,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(error_x_arrayminus=<VALUE>, selector=dict(type='bar'))"
},
- "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 stroke color of the error bars.",
"editType": "style",
@@ -25858,16 +24456,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(error_y_arrayminus=<VALUE>, selector=dict(type='bar'))"
},
- "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 stroke color of the error bars.",
"editType": "style",
@@ -26057,11 +24645,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='bar'))"
},
- "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",
@@ -26069,11 +24652,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26081,11 +24659,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='bar'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -26094,11 +24667,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='bar'))"
},
- "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": {
@@ -26110,11 +24678,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26131,11 +24694,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='bar'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -26145,11 +24703,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='bar'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -26157,11 +24710,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26174,11 +24722,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26193,11 +24736,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26214,11 +24752,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26233,11 +24766,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='bar'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='bar'))"
},
"namelength": {
@@ -26249,11 +24777,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='bar'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -26283,11 +24806,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='bar'))"
},
- "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": {
@@ -26299,11 +24817,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26320,11 +24833,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='bar'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -26334,11 +24842,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='bar'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -26346,11 +24849,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26363,11 +24861,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26382,11 +24875,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26403,11 +24891,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26422,11 +24905,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='bar'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='bar'))"
},
"outsidetextfont": {
@@ -26436,11 +24914,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='bar'))"
},
- "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": {
@@ -26452,11 +24925,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26473,11 +24941,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='bar'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -26487,11 +24950,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='bar'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -26499,11 +24957,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26516,11 +24969,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26535,11 +24983,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26556,11 +24999,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='bar'))"
},
- "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.",
@@ -26575,11 +25013,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='bar'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='bar'))"
},
"xcalendar": {
@@ -26638,28 +25071,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='bar'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='bar'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='bar'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='bar'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='bar'))"
},
"categories": [
@@ -26747,11 +25158,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(title_font_color=<VALUE>, selector=dict(type='pie'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"description": "Sets the font used for `title`.",
"editType": "plot",
"family": {
@@ -26763,11 +25169,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(title_font_family=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -26784,11 +25185,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(title_font_lineposition=<VALUE>, selector=dict(type='pie'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -26798,11 +25194,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(title_font_shadow=<VALUE>, selector=dict(type='pie'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -26810,11 +25201,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(title_font_size=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -26827,11 +25213,6 @@
],
"magic_underscores": "fig.update_traces(title_font_style=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -26846,11 +25227,6 @@
],
"magic_underscores": "fig.update_traces(title_font_textcase=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -26867,11 +25243,6 @@
],
"magic_underscores": "fig.update_traces(title_font_variant=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -26886,11 +25257,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(title_font_weight=<VALUE>, selector=dict(type='pie'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(title_font=dict(...), selector=dict(type='pie'))"
},
"position": {
@@ -26938,11 +25304,6 @@
"valType": "boolean",
"magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='pie'))"
},
- "showlegendsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `showlegend`.",
- "editType": "none",
- "valType": "string"
- },
"legend": {
"arrayOk": true,
"description": "Sets the reference to a legend to show the pie slices in. Can be an array if `values` is set. In that case, each entry specifies the legend reference for one slice. References to these legends are *legend*, *legend2*, *legend3*, etc. Settings for these legends are set in the layout, under `layout.legend`, `layout.legend2`, etc.",
@@ -26951,11 +25312,6 @@
"valType": "subplotid",
"magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='pie'))"
},
- "legendsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `legend`.",
- "editType": "none",
- "valType": "string"
- },
"legendrank": {
"arrayOk": true,
"description": "Sets the legend rank for this pie. If passed as an array, this will set the legend rank of the individual pie slices. 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.",
@@ -26964,11 +25320,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='pie'))"
},
- "legendranksrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `legendrank`.",
- "editType": "none",
- "valType": "string"
- },
"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": "",
@@ -27109,33 +25460,18 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='pie'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"values": {
"description": "Sets the values of the sectors. If omitted, we count occurrences of each label.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(values=<VALUE>, selector=dict(type='pie'))"
},
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
"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",
"magic_underscores": "fig.update_traces(labels=<VALUE>, selector=dict(type='pie'))"
},
- "labelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
- "editType": "none",
- "valType": "string"
- },
"dlabel": {
"description": "Sets the label step. See `label0` for more info.",
"dflt": 1,
@@ -27160,22 +25496,12 @@
"valType": "number",
"magic_underscores": "fig.update_traces(pull=<VALUE>, selector=dict(type='pie'))"
},
- "pullsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `pull`.",
- "editType": "none",
- "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",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='pie'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"arrayOk": true,
"description": "Specifies the location of the `textinfo`.",
@@ -27190,11 +25516,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='pie'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`.",
@@ -27210,11 +25531,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='pie'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -27223,14 +25539,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='pie'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. Flags are rendered in a fixed order; use `hovertemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"dflt": "all",
"editType": "none",
"extras": [
@@ -27248,11 +25559,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='pie'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -27268,11 +25574,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='pie'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -27280,25 +25581,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='pie'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='pie'))"
},
- "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 pie trace .",
+ "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,
@@ -27308,7 +25599,7 @@
"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 .",
+ "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,
@@ -27379,11 +25670,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colors=<VALUE>, selector=dict(type='pie'))"
},
- "colorssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"line": {
"color": {
@@ -27394,11 +25680,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='pie'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"width": {
@@ -27410,11 +25691,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='pie'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='pie'))"
},
"pattern": {
@@ -27425,11 +25701,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='pie'))"
},
- "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": {
@@ -27439,11 +25710,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='pie'))"
},
- "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",
@@ -27470,11 +25736,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='pie'))"
},
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shape": {
"arrayOk": true,
@@ -27494,11 +25755,6 @@
],
"magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27508,11 +25764,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27523,11 +25774,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='pie'))"
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='pie'))"
},
"role": "object",
@@ -27540,11 +25786,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='pie'))"
},
- "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": {
@@ -27556,11 +25797,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27577,11 +25813,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='pie'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -27591,11 +25822,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='pie'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -27603,11 +25829,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27620,11 +25841,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27639,11 +25855,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27660,11 +25871,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27679,15 +25885,10 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='pie'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='pie'))"
},
"textinfo": {
- "description": "Determines which trace information appear on the graph.",
+ "description": "Determines what trace information appears on the graph. Flags are rendered in a fixed order; use `texttemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"editType": "calc",
"extras": [
"none"
@@ -27735,11 +25936,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='pie'))"
},
- "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",
@@ -27747,11 +25943,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27759,11 +25950,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='pie'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -27772,11 +25958,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='pie'))"
},
- "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": {
@@ -27788,11 +25969,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27809,11 +25985,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='pie'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -27823,11 +25994,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='pie'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -27835,11 +26001,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27852,11 +26013,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27871,11 +26027,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27892,11 +26043,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27911,11 +26057,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='pie'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='pie'))"
},
"namelength": {
@@ -27927,11 +26068,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='pie'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -27949,11 +26085,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='pie'))"
},
- "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": {
@@ -27965,11 +26096,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -27986,11 +26112,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='pie'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -28000,11 +26121,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='pie'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -28012,11 +26128,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28029,11 +26140,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28048,11 +26154,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28069,11 +26170,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28088,11 +26184,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='pie'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='pie'))"
},
"insidetextorientation": {
@@ -28115,11 +26206,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='pie'))"
},
- "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": {
@@ -28131,11 +26217,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28152,11 +26233,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='pie'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -28166,11 +26242,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='pie'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -28178,11 +26249,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28195,11 +26261,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28214,11 +26275,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28235,11 +26291,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='pie'))"
},
- "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.",
@@ -28254,11 +26305,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='pie'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='pie'))"
},
"rotation": {
@@ -28288,28 +26334,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='pie'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='pie'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='pie'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='pie'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='pie'))"
},
"categories": [
@@ -28329,11 +26353,6 @@
"editType": "calc",
"valType": "data_array"
},
- "hiddenlabelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hiddenlabels`.",
- "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",
@@ -28534,11 +26553,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='heatmap'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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,
@@ -28556,11 +26570,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='heatmap'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
"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,
@@ -28611,11 +26620,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='heatmap'))"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
"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,
@@ -28662,22 +26666,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='heatmap'))"
},
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
"text": {
"description": "Sets the text elements associated with each z value.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='heatmap'))"
},
- "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 appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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": "",
@@ -28698,14 +26692,9 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='heatmap'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -28723,11 +26712,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='heatmap'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -28743,20 +26727,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='heatmap'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
"magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='heatmap'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
@@ -28769,22 +26748,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='heatmap'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='heatmap'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
@@ -29442,22 +27411,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='heatmap'))"
},
- "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",
"magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='heatmap'))"
},
- "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,
@@ -29569,7 +27528,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -29672,7 +27631,7 @@
"magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='heatmap'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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": {
@@ -29707,7 +27666,7 @@
"magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='heatmap'))"
},
"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 rule for `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",
@@ -29777,11 +27736,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='heatmap'))"
},
- "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",
@@ -29789,11 +27743,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='heatmap'))"
},
- "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.",
@@ -29801,11 +27750,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='heatmap'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -29814,11 +27758,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='heatmap'))"
},
- "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": {
@@ -29830,11 +27769,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='heatmap'))"
},
- "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.",
@@ -29851,11 +27785,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='heatmap'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -29865,11 +27794,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='heatmap'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -29877,11 +27801,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='heatmap'))"
},
- "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.",
@@ -29894,11 +27813,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='heatmap'))"
},
- "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.",
@@ -29913,11 +27827,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='heatmap'))"
},
- "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.",
@@ -29934,11 +27843,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='heatmap'))"
},
- "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.",
@@ -29953,11 +27857,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='heatmap'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='heatmap'))"
},
"namelength": {
@@ -29969,11 +27868,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='heatmap'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -30054,28 +27948,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='heatmap'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='heatmap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='heatmap'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='heatmap'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='heatmap'))"
},
"categories": [
@@ -30264,11 +28136,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='image'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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,
@@ -30310,11 +28177,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='image'))"
},
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
"source": {
"description": "Specifies the data URI of the image to be visualized. The URI consists of \"data:image/[][;base64\\\\],\"",
"editType": "calc",
@@ -30327,25 +28189,15 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='image'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"hovertext": {
"description": "Same as `text`.",
"editType": "plot",
"valType": "data_array",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='image'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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",
"editType": "none",
"extras": [
@@ -30364,11 +28216,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='image'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -30384,11 +28231,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='image'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -30396,22 +28238,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='image'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='image'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
@@ -30512,11 +28344,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='image'))"
},
- "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",
@@ -30524,11 +28351,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='image'))"
},
- "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.",
@@ -30536,11 +28358,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='image'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -30549,11 +28366,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='image'))"
},
- "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": {
@@ -30565,11 +28377,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='image'))"
},
- "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.",
@@ -30586,11 +28393,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='image'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -30600,11 +28402,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='image'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -30612,11 +28409,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='image'))"
},
- "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.",
@@ -30629,11 +28421,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='image'))"
},
- "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.",
@@ -30648,11 +28435,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='image'))"
},
- "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.",
@@ -30669,11 +28451,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='image'))"
},
- "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.",
@@ -30688,11 +28465,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='image'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='image'))"
},
"namelength": {
@@ -30704,11 +28476,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='image'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -30725,28 +28492,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='image'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='image'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='image'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='image'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='image'))"
},
"categories": [
@@ -30949,11 +28694,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='contour'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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,
@@ -30971,11 +28711,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='contour'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
"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,
@@ -31018,11 +28753,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='contour'))"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
"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,
@@ -31061,22 +28791,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='contour'))"
},
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
"text": {
"description": "Sets the text elements associated with each z value.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='contour'))"
},
- "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 appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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": "",
@@ -31097,14 +28817,9 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='contour'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -31122,11 +28837,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='contour'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -31142,20 +28852,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='contour'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
"magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='contour'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
@@ -31168,22 +28873,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='contour'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='contour'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
@@ -31875,22 +29570,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='contour'))"
},
- "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",
"magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='contour'))"
},
- "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,
@@ -32002,7 +29687,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -32105,7 +29790,7 @@
"magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='contour'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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": {
@@ -32140,7 +29825,7 @@
"magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='contour'))"
},
"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 rule for `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",
@@ -32332,7 +30017,7 @@
"magic_underscores": "fig.update_traces(contours_labelformat=<VALUE>, selector=dict(type='contour'))"
},
"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.",
+ "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.",
"dflt": "=",
"editType": "calc",
"valType": "enumerated",
@@ -32431,11 +30116,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='contour'))"
},
- "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",
@@ -32443,11 +30123,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='contour'))"
},
- "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.",
@@ -32455,11 +30130,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='contour'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -32468,11 +30138,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='contour'))"
},
- "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": {
@@ -32484,11 +30149,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='contour'))"
},
- "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.",
@@ -32505,11 +30165,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='contour'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -32519,11 +30174,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='contour'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -32531,11 +30181,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='contour'))"
},
- "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.",
@@ -32548,11 +30193,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='contour'))"
},
- "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.",
@@ -32567,11 +30207,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='contour'))"
},
- "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.",
@@ -32588,11 +30223,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='contour'))"
},
- "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.",
@@ -32607,11 +30237,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='contour'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='contour'))"
},
"namelength": {
@@ -32623,11 +30248,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='contour'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -32716,28 +30336,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='contour'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='contour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='contour'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='contour'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='contour'))"
},
"categories": [
@@ -32752,21 +30350,22 @@
},
"type": "contour"
},
- "table": {
- "animatable": false,
+ "quiver": {
+ "animatable": true,
"attributes": {
- "type": "table",
+ "type": "quiver",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='quiver'))"
},
"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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='quiver'))"
},
"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).",
@@ -32778,21 +30377,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='quiver'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='quiver'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='quiver'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -32800,7 +30413,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='quiver'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -32810,7 +30423,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='quiver'))"
},
"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.",
@@ -32825,7 +30438,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='quiver'))"
},
"role": "object",
"shadow": {
@@ -32833,13 +30446,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='quiver'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='quiver'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -32850,7 +30463,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='quiver'))"
},
"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.",
@@ -32863,7 +30476,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='quiver'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -32878,7 +30491,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='quiver'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -32891,9 +30504,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='quiver'))"
},
"role": "object",
"text": {
@@ -32901,55 +30514,123 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='quiver'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='quiver'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='quiver'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "x": {
+ "anim": true,
+ "description": "Sets the x coordinates of the arrow locations.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='quiver'))"
},
- "columnorder": {
- "description": "Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero.",
+ "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",
+ "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "dx": {
+ "anim": true,
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
"editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(dx=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "y": {
+ "anim": true,
+ "description": "Sets the y coordinates of the arrow locations.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(columnorder=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='quiver'))"
},
- "columnordersrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `columnorder`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='quiver'))"
},
- "columnwidth": {
- "arrayOk": true,
- "description": "The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.",
- "dflt": null,
+ "dy": {
+ "anim": true,
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
"editType": "calc",
"valType": "number",
- "magic_underscores": "fig.update_traces(columnwidth=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(dy=<VALUE>, selector=dict(type='quiver'))"
},
- "columnwidthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `columnwidth`.",
- "editType": "none",
- "valType": "string"
+ "u": {
+ "anim": true,
+ "description": "Sets the x components of the arrow vectors.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(u=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "v": {
+ "anim": true,
+ "description": "Sets the y components of the arrow vectors.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(v=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='quiver'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -32960,669 +30641,1082 @@
"flags": [
"x",
"y",
- "z",
+ "u",
+ "v",
"text",
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='quiver'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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`, `u`, `v`, `text` and `name`. 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"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "uhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(uhoverformat=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "vhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(vhoverformat=<VALUE>, selector=dict(type='quiver'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='table'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='quiver'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='quiver'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='quiver'))"
},
- "domain": {
- "column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this table trace .",
- "dflt": 0,
+ "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",
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "marker": {
+ "arrowsize": {
+ "description": "Sets the size of the arrow head relative to `marker.line.width`. A value of 1 (default) gives a head about 3x as wide as the line.",
+ "dflt": 1,
"editType": "calc",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(domain_column=<VALUE>, selector=dict(type='table'))"
+ "min": 0.3,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_arrowsize=<VALUE>, selector=dict(type='quiver'))"
},
- "editType": "calc",
- "role": "object",
- "row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this table trace .",
- "dflt": 0,
+ "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",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(domain_row=<VALUE>, selector=dict(type='table'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='quiver'))"
},
- "x": {
- "description": "Sets the horizontal domain of this table trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
+ "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",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array",
- "magic_underscores": "fig.update_traces(domain_x=list(...), selector=dict(type='table'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='quiver'))"
},
- "y": {
- "description": "Sets the vertical domain of this table trace (in plot fraction).",
- "dflt": [
- 0,
- 1
- ],
+ "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",
- "items": [
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array",
- "magic_underscores": "fig.update_traces(domain_y=list(...), selector=dict(type='table'))"
+ "impliedEdits": {
+ "cauto": false,
+ "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(domain=dict(...), selector=dict(type='table'))"
- },
- "cells": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more HTML tags) or if an explicit width is set to override the text width.",
- "dflt": "center",
+ "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": [
- "left",
- "center",
- "right"
- ],
- "magic_underscores": "fig.update_traces(cells_align=<VALUE>, selector=dict(type='table'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "fill": {
- "color": {
- "arrayOk": true,
- "description": "Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.",
- "dflt": "white",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(cells_fill_color=<VALUE>, selector=dict(type='table'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
},
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
- "role": "object",
- "magic_underscores": "fig.update_traces(cells_fill=dict(...), selector=dict(type='table'))"
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='quiver'))"
},
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "calc",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(cells_font_color=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='quiver'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='quiver'))"
},
- "description": "",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(cells_font_family=<VALUE>, selector=dict(type='table'))"
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='quiver'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='quiver'))"
},
- "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"
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(cells_font_lineposition=<VALUE>, selector=dict(type='table'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cells_font_shadow=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='quiver'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='quiver'))"
},
- "size": {
- "arrayOk": true,
- "editType": "calc",
- "min": 1,
+ "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",
- "magic_underscores": "fig.update_traces(cells_font_size=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='quiver'))"
},
- "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",
+ "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": [
- "normal",
- "italic"
+ "fraction",
+ "pixels"
],
- "magic_underscores": "fig.update_traces(cells_font_style=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='quiver'))"
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='quiver'))"
},
- "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",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "h",
+ "v"
],
- "magic_underscores": "fig.update_traces(cells_font_textcase=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='quiver'))"
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='quiver'))"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "all",
+ "first",
+ "last",
+ "none"
],
- "magic_underscores": "fig.update_traces(cells_font_variant=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='quiver'))"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='quiver'))"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
+ "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"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(cells_font_weight=<VALUE>, selector=dict(type='table'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(cells_font=dict(...), selector=dict(type='table'))"
- },
- "format": {
- "description": "Sets the cell 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": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(cells_format=<VALUE>, selector=dict(type='table'))"
- },
- "formatsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `format`.",
- "editType": "none",
- "valType": "string"
- },
- "height": {
- "description": "The height of cells.",
- "dflt": 20,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(cells_height=<VALUE>, selector=dict(type='table'))"
- },
- "line": {
- "color": {
- "arrayOk": true,
- "dflt": "grey",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(cells_line_color=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='quiver'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='quiver'))"
},
- "editType": "calc",
- "role": "object",
- "width": {
- "arrayOk": true,
- "dflt": 1,
- "editType": "calc",
+ "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",
- "magic_underscores": "fig.update_traces(cells_line_width=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='quiver'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "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",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(cells_line=dict(...), selector=dict(type='table'))"
- },
- "prefix": {
- "arrayOk": true,
- "description": "Prefix for cell values.",
- "dflt": null,
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(cells_prefix=<VALUE>, selector=dict(type='table'))"
- },
- "prefixsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `prefix`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "suffix": {
- "arrayOk": true,
- "description": "Suffix for cell values.",
- "dflt": null,
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(cells_suffix=<VALUE>, selector=dict(type='table'))"
- },
- "suffixsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `suffix`.",
- "editType": "none",
- "valType": "string"
- },
- "values": {
- "description": "Cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(cells_values=<VALUE>, selector=dict(type='table'))"
- },
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(cells=dict(...), selector=dict(type='table'))"
- },
- "header": {
- "align": {
- "arrayOk": true,
- "description": "Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more HTML tags) or if an explicit width is set to override the text width.",
- "dflt": "center",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "left",
- "center",
- "right"
- ],
- "magic_underscores": "fig.update_traces(header_align=<VALUE>, selector=dict(type='table'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "fill": {
- "color": {
- "arrayOk": true,
- "description": "Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.",
- "dflt": "white",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(header_fill_color=<VALUE>, selector=dict(type='table'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='quiver'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='quiver'))"
},
- "editType": "calc",
- "role": "object",
- "magic_underscores": "fig.update_traces(header_fill=dict(...), selector=dict(type='table'))"
- },
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "calc",
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(header_font_color=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='quiver'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='quiver'))"
},
- "description": "",
- "editType": "calc",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
+ "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",
- "magic_underscores": "fig.update_traces(header_font_family=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='quiver'))"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='quiver'))"
},
- "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"
+ "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"
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(header_font_lineposition=<VALUE>, selector=dict(type='table'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='quiver'))"
},
- "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",
- "magic_underscores": "fig.update_traces(header_font_shadow=<VALUE>, selector=dict(type='table'))"
- },
- "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='quiver'))"
},
- "size": {
- "arrayOk": true,
- "editType": "calc",
+ "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",
- "magic_underscores": "fig.update_traces(header_font_size=<VALUE>, selector=dict(type='table'))"
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='quiver'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='quiver'))"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
+ },
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "auto",
+ "linear",
+ "array"
],
- "magic_underscores": "fig.update_traces(header_font_style=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='quiver'))"
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='quiver'))"
},
- "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",
+ "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",
+ ""
],
- "magic_underscores": "fig.update_traces(header_font_textcase=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='quiver'))"
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='quiver'))"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='quiver'))"
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
],
- "magic_underscores": "fig.update_traces(header_font_variant=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='quiver'))"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='quiver'))"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
+ "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"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(header_font_weight=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='quiver'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(header_font=dict(...), selector=dict(type='table'))"
- },
- "format": {
- "description": "Sets the cell 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": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(header_format=<VALUE>, selector=dict(type='table'))"
- },
- "formatsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `format`.",
- "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",
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='quiver'))"
},
- "height": {
- "description": "The height of cells.",
- "dflt": 28,
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": "number",
- "magic_underscores": "fig.update_traces(header_height=<VALUE>, selector=dict(type='table'))"
+ "impliedEdits": {
+ "autocolorscale": false,
+ "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='quiver'))"
},
+ "editType": "calc",
"line": {
- "color": {
- "arrayOk": true,
- "dflt": "grey",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(header_line_color=<VALUE>, selector=dict(type='table'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "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",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ],
+ "magic_underscores": "fig.update_traces(marker_line_dash=<VALUE>, selector=dict(type='quiver'))"
},
- "editType": "calc",
+ "editType": "style",
"role": "object",
"width": {
- "arrayOk": true,
- "dflt": 1,
- "editType": "calc",
+ "description": "Sets the width (in px) of the arrow lines.",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(header_line_width=<VALUE>, selector=dict(type='table'))"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(header_line=dict(...), selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='quiver'))"
},
- "prefix": {
+ "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",
+ "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='quiver'))"
+ },
+ "textfont": {
+ "color": {
"arrayOk": true,
- "description": "Prefix for cell values.",
- "dflt": null,
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
"editType": "calc",
+ "noBlank": true,
+ "strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(header_prefix=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='quiver'))"
},
- "prefixsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `prefix`.",
- "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",
+ "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='quiver'))"
},
"role": "object",
- "suffix": {
+ "shadow": {
"arrayOk": true,
- "description": "Suffix for cell values.",
- "dflt": null,
+ "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",
- "magic_underscores": "fig.update_traces(header_suffix=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='quiver'))"
},
- "suffixsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `suffix`.",
- "editType": "none",
- "valType": "string"
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='quiver'))"
},
- "values": {
- "description": "Header cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.",
- "dflt": [],
+ "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": "data_array",
- "magic_underscores": "fig.update_traces(header_values=<VALUE>, selector=dict(type='table'))"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='quiver'))"
},
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(header=dict(...), selector=dict(type='table'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "selected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of selected points.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "editType": "style",
+ "line": {
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width of selected points.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(selected_marker_line_width=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(selected_marker_line=dict(...), selector=dict(type='quiver'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='quiver'))"
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of selected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(selected_textfont_color=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "editType": "style",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(selected_textfont=dict(...), selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='quiver'))"
+ },
+ "unselected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "editType": "style",
+ "line": {
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(unselected_marker_line_width=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(unselected_marker_line=dict(...), selector=dict(type='quiver'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='quiver'))"
+ },
+ "role": "object",
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(unselected_textfont_color=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "editType": "style",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(unselected_textfont=dict(...), selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='quiver'))"
+ },
+ "anchor": {
+ "description": "Sets the arrows' anchor with respect to their (x,y) positions. Use *tail* to place (x,y) at the base, *tip* to place (x,y) at the head, or *center* to center the arrow on (x,y).",
+ "dflt": "tail",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "tip",
+ "tail",
+ "center"
+ ],
+ "magic_underscores": "fig.update_traces(anchor=<VALUE>, selector=dict(type='quiver'))"
},
"hoverlabel": {
"align": {
@@ -33636,36 +31730,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='table'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='quiver'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='table'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='quiver'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='table'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='quiver'))"
},
"editType": "none",
"font": {
@@ -33673,12 +31752,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='table'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='quiver'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -33689,12 +31763,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='table'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='quiver'))"
},
"lineposition": {
"arrayOk": true,
@@ -33710,12 +31779,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='table'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='quiver'))"
},
"role": "object",
"shadow": {
@@ -33724,24 +31788,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='table'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='quiver'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='table'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='quiver'))"
},
"style": {
"arrayOk": true,
@@ -33753,12 +31807,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='table'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='quiver'))"
},
"textcase": {
"arrayOk": true,
@@ -33772,12 +31821,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='table'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='quiver'))"
},
"variant": {
"arrayOk": true,
@@ -33793,12 +31837,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='table'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='quiver'))"
},
"weight": {
"arrayOk": true,
@@ -33812,14 +31851,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='table'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='quiver'))"
},
"namelength": {
"arrayOk": true,
@@ -33828,12 +31862,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='table'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='quiver'))"
},
"role": "object",
"showarrow": {
@@ -33841,64 +31870,75 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='quiver'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='table'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='table'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='quiver'))"
},
- "stream": {
+ "sizemode": {
+ "description": "Determines whether arrows are drawn according to their raw lengths, or scaled based on the maximum vector length and point density. Note: When `anglemode` is *data* arrows are alwyas scaled and `sizemode` *raw* is ignored.",
+ "dflt": "scaled",
"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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='table'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='table'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='table'))"
+ "valType": "enumerated",
+ "values": [
+ "scaled",
+ "raw"
+ ],
+ "magic_underscores": "fig.update_traces(sizemode=<VALUE>, selector=dict(type='quiver'))"
},
- "editType": "calc",
- "magic_underscores": "fig.update_traces(..., selector=dict(type='table'))"
+ "sizeref": {
+ "description": "Adjusts the arrow size scaling. The arrow length is determined by the vector norm multiplied by `sizeref`, optionally normalized when `sizemode` is *scaled* (`sizeref` is applied after scaling).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(sizeref=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "anglemode": {
+ "description": "Sets the mode used to determine the angle of the arrow vectors. If *paper*, u/v are interpreted in pixel coordinates and the rendered vector angle does not change regardless of the axes scales. If *data*, u/v are interpreted in data coordinates and the rendered vector angle may change, e.g. if zooming in along a single axis",
+ "dflt": "axis",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "paper",
+ "data"
+ ],
+ "magic_underscores": "fig.update_traces(anglemode=<VALUE>, selector=dict(type='quiver'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='quiver'))"
},
"categories": [
- "noOpacity"
+ "cartesian",
+ "svg",
+ "showLegend",
+ "scatter-like",
+ "zoomScale"
],
"meta": {
- "description": "Table view for detailed data viewing. The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column-major order, ie. the grid is represented as a vector of column vectors."
+ "description": "The quiver trace type visualizes vector fields using arrows. Specify a vector field using 4 1D arrays: 2 position arrays `x`, `y` and 2 vector component arrays `u`, `v`. The arrows are drawn exactly at the positions given by `x` and `y`. Arrow length and direction are determined by `u` and `v` components."
},
- "type": "table"
+ "type": "quiver"
},
- "box": {
+ "table": {
"animatable": false,
"attributes": {
- "type": "box",
+ "type": "table",
"name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical",
- "editType": "calc+clearAxisTypes",
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='table'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='table'))"
},
"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).",
@@ -33910,35 +31950,21 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='box'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='table'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='table'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='table'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -33946,7 +31972,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='table'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -33956,7 +31982,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='table'))"
},
"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.",
@@ -33971,7 +31997,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='table'))"
},
"role": "object",
"shadow": {
@@ -33979,13 +32005,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='table'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='table'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -33996,7 +32022,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='table'))"
},
"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.",
@@ -34009,7 +32035,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='table'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -34024,7 +32050,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='table'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -34037,9 +32063,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='table'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='table'))"
},
"role": "object",
"text": {
@@ -34047,127 +32073,40 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='table'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='table'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='box'))"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='table'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='box'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
- "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='box'))"
- },
- "x": {
- "description": "Sets the x sample data or coordinates. See overview for more info.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='box'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "x0": {
- "description": "Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
- "editType": "calc+clearAxisTypes",
- "valType": "any",
- "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='table'))"
},
- "dx": {
- "description": "Sets the x coordinate step for multi-box traces set using q1/median/q3.",
+ "columnorder": {
+ "description": "Specifies the rendered order of the data columns; for example, a value `2` at position `0` means that column index `0` in the data will be rendered as the third column, as columns have an index base of zero.",
"editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(dx=<VALUE>, selector=dict(type='box'))"
- },
- "y": {
- "description": "Sets the y sample data or coordinates. See overview for more info.",
- "editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='box'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "y0": {
- "description": "Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
- "editType": "calc+clearAxisTypes",
- "valType": "any",
- "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='box'))"
- },
- "dy": {
- "description": "Sets the y coordinate step for multi-box traces set using q1/median/q3.",
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(dy=<VALUE>, selector=dict(type='box'))"
- },
- "width": {
- "description": "Sets the width of the box in data coordinate If *0* (default value) the width is automatically selected based on the positions of other box traces in the same subplot.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(columnorder=<VALUE>, selector=dict(type='table'))"
},
- "text": {
+ "columnwidth": {
"arrayOk": true,
- "description": "Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
- "dflt": "",
+ "description": "The width of columns expressed as a ratio. Columns fill the available width in proportion of their specified column widths.",
+ "dflt": null,
"editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='box'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='box'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(columnwidth=<VALUE>, selector=dict(type='table'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -34183,1067 +32122,731 @@
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='box'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='box'))"
- },
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "none",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='box'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='table'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='box'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='table'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='box'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='box'))"
- },
- "orientation": {
- "description": "Sets the orientation of the box(es). If *v* (*h*), the distribution is visualized along the vertical (horizontal).",
- "editType": "calc+clearAxisTypes",
- "valType": "enumerated",
- "values": [
- "v",
- "h"
- ],
- "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='box'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yperiod=<VALUE>, selector=dict(type='box'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(yperiodalignment=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='table'))"
},
- "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.",
+ "domain": {
+ "column": {
+ "description": "If there is a layout grid, use the domain for this column in the grid for this table trace.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(domain_column=<VALUE>, selector=dict(type='table'))"
+ },
"editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(yperiod0=<VALUE>, selector=dict(type='box'))"
- },
- "marker": {
- "angle": {
- "arrayOk": false,
- "description": "Sets the marker angle in respect to `angleref`.",
+ "role": "object",
+ "row": {
+ "description": "If there is a layout grid, use the domain for this row in the grid for this table trace.",
"dflt": 0,
"editType": "calc",
- "valType": "angle",
- "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='box'))"
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(domain_row=<VALUE>, selector=dict(type='table'))"
},
- "color": {
- "arrayOk": false,
- "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",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='box'))"
+ "x": {
+ "description": "Sets the horizontal domain of this table 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",
+ "magic_underscores": "fig.update_traces(domain_x=list(...), selector=dict(type='table'))"
},
- "editType": "plot",
- "line": {
+ "y": {
+ "description": "Sets the vertical domain of this table 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",
+ "magic_underscores": "fig.update_traces(domain_y=list(...), selector=dict(type='table'))"
+ },
+ "magic_underscores": "fig.update_traces(domain=dict(...), selector=dict(type='table'))"
+ },
+ "cells": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more HTML tags) or if an explicit width is set to override the text width.",
+ "dflt": "center",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ],
+ "magic_underscores": "fig.update_traces(cells_align=<VALUE>, selector=dict(type='table'))"
+ },
+ "editType": "calc",
+ "fill": {
"color": {
- "arrayOk": false,
- "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": "style",
+ "arrayOk": true,
+ "description": "Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.",
+ "dflt": "white",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(cells_fill_color=<VALUE>, selector=dict(type='table'))"
},
- "editType": "style",
- "outliercolor": {
- "description": "Sets the border line color of the outlier sample points. Defaults to marker.color",
- "editType": "style",
+ "editType": "calc",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(cells_fill=dict(...), selector=dict(type='table'))"
+ },
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_line_outliercolor=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(cells_font_color=<VALUE>, selector=dict(type='table'))"
},
- "outlierwidth": {
- "description": "Sets the border line width (in px) of the outlier sample points.",
- "dflt": 1,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_outlierwidth=<VALUE>, selector=dict(type='box'))"
+ "description": "",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(cells_font_family=<VALUE>, selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(cells_font_lineposition=<VALUE>, selector=dict(type='table'))"
},
"role": "object",
- "width": {
- "arrayOk": false,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "dflt": 0,
- "editType": "style",
- "min": 0,
+ "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",
+ "magic_underscores": "fig.update_traces(cells_font_shadow=<VALUE>, selector=dict(type='table'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(cells_font_size=<VALUE>, selector=dict(type='table'))"
},
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='box'))"
- },
- "opacity": {
- "arrayOk": false,
- "description": "Sets the marker opacity.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='box'))"
- },
- "outliercolor": {
- "description": "Sets the color of the outlier sample points.",
- "dflt": "rgba(0, 0, 0, 0)",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_outliercolor=<VALUE>, selector=dict(type='box'))"
- },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(cells_font_style=<VALUE>, selector=dict(type='table'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(cells_font_textcase=<VALUE>, selector=dict(type='table'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(cells_font_variant=<VALUE>, selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(cells_font_weight=<VALUE>, selector=dict(type='table'))"
+ },
+ "magic_underscores": "fig.update_traces(cells_font=dict(...), selector=dict(type='table'))"
+ },
+ "format": {
+ "description": "Sets the cell 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": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(cells_format=<VALUE>, selector=dict(type='table'))"
+ },
+ "height": {
+ "description": "The height of cells.",
+ "dflt": 20,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cells_height=<VALUE>, selector=dict(type='table'))"
+ },
+ "line": {
+ "color": {
+ "arrayOk": true,
+ "dflt": "grey",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(cells_line_color=<VALUE>, selector=dict(type='table'))"
+ },
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cells_line_width=<VALUE>, selector=dict(type='table'))"
+ },
+ "magic_underscores": "fig.update_traces(cells_line=dict(...), selector=dict(type='table'))"
+ },
+ "prefix": {
+ "arrayOk": true,
+ "description": "Prefix for cell values.",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(cells_prefix=<VALUE>, selector=dict(type='table'))"
+ },
"role": "object",
- "size": {
- "arrayOk": false,
- "description": "Sets the marker size (in px).",
- "dflt": 6,
+ "suffix": {
+ "arrayOk": true,
+ "description": "Suffix for cell values.",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(cells_suffix=<VALUE>, selector=dict(type='table'))"
+ },
+ "values": {
+ "description": "Cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(cells_values=<VALUE>, selector=dict(type='table'))"
+ },
+ "magic_underscores": "fig.update_traces(cells=dict(...), selector=dict(type='table'))"
+ },
+ "header": {
+ "align": {
+ "arrayOk": true,
+ "description": "Sets the horizontal alignment of the `text` within the box. Has an effect only if `text` spans two or more lines (i.e. `text` contains one or more HTML tags) or if an explicit width is set to override the text width.",
+ "dflt": "center",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ],
+ "magic_underscores": "fig.update_traces(header_align=<VALUE>, selector=dict(type='table'))"
+ },
+ "editType": "calc",
+ "fill": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the cell fill color. It accepts either a specific color or an array of colors or a 2D array of colors.",
+ "dflt": "white",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(header_fill_color=<VALUE>, selector=dict(type='table'))"
+ },
+ "editType": "calc",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(header_fill=dict(...), selector=dict(type='table'))"
+ },
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(header_font_color=<VALUE>, selector=dict(type='table'))"
+ },
+ "description": "",
+ "editType": "calc",
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(header_font_family=<VALUE>, selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(header_font_lineposition=<VALUE>, selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(header_font_shadow=<VALUE>, selector=dict(type='table'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(header_font_size=<VALUE>, selector=dict(type='table'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(header_font_style=<VALUE>, selector=dict(type='table'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(header_font_textcase=<VALUE>, selector=dict(type='table'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(header_font_variant=<VALUE>, selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(header_font_weight=<VALUE>, selector=dict(type='table'))"
+ },
+ "magic_underscores": "fig.update_traces(header_font=dict(...), selector=dict(type='table'))"
+ },
+ "format": {
+ "description": "Sets the cell 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": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(header_format=<VALUE>, selector=dict(type='table'))"
+ },
+ "height": {
+ "description": "The height of cells.",
+ "dflt": 28,
"editType": "calc",
- "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(header_height=<VALUE>, selector=dict(type='table'))"
},
- "symbol": {
- "arrayOk": false,
- "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": "plot",
+ "line": {
+ "color": {
+ "arrayOk": true,
+ "dflt": "grey",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(header_line_color=<VALUE>, selector=dict(type='table'))"
+ },
+ "editType": "calc",
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(header_line_width=<VALUE>, selector=dict(type='table'))"
+ },
+ "magic_underscores": "fig.update_traces(header_line=dict(...), selector=dict(type='table'))"
+ },
+ "prefix": {
+ "arrayOk": true,
+ "description": "Prefix for cell values.",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(header_prefix=<VALUE>, selector=dict(type='table'))"
+ },
+ "role": "object",
+ "suffix": {
+ "arrayOk": true,
+ "description": "Suffix for cell values.",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(header_suffix=<VALUE>, selector=dict(type='table'))"
+ },
+ "values": {
+ "description": "Header cell values. `values[m][n]` represents the value of the `n`th point in column `m`, therefore the `values[m]` vector length for all columns must be the same (longer vectors will be truncated). Each value must be a finite number or a string.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(header_values=<VALUE>, selector=dict(type='table'))"
+ },
+ "magic_underscores": "fig.update_traces(header=dict(...), selector=dict(type='table'))"
+ },
+ "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": [
- 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"
+ "left",
+ "right",
+ "auto"
],
- "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='table'))"
},
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='box'))"
- },
- "line": {
- "color": {
- "description": "Sets the color of line bounding the box(es).",
- "editType": "style",
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='table'))"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='table'))"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='table'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='table'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='table'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='table'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='table'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='table'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='table'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='table'))"
},
- "editType": "plot",
"role": "object",
- "width": {
- "description": "Sets the width (in px) of line bounding the box(es).",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='box'))"
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='table'))"
},
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='table'))"
},
- "boxmean": {
- "description": "If *true*, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If *sd* the standard deviation is also drawn. Defaults to *true* when `mean` is set. Defaults to *sd* when `sd` is set Otherwise defaults to *false*.",
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='table'))"
+ },
+ "editType": "calc",
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='table'))"
+ },
+ "categories": [
+ "noOpacity"
+ ],
+ "meta": {
+ "description": "Table view for detailed data viewing. The data are arranged in a grid of rows and columns. Most styling can be specified for columns, rows or individual cells. Table is using a column-major order, ie. the grid is represented as a vector of column vectors."
+ },
+ "type": "table"
+ },
+ "box": {
+ "animatable": false,
+ "attributes": {
+ "type": "box",
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover. For box traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical",
+ "editType": "calc+clearAxisTypes",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='box'))"
+ },
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='box'))"
+ },
+ "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,
- "sd",
- false
+ false,
+ "legendonly"
],
- "magic_underscores": "fig.update_traces(boxmean=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='box'))"
},
- "boxpoints": {
- "description": "If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the box(es) are shown with no sample points Defaults to *suspectedoutliers* when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to *all* under the q1/median/q3 signature. Otherwise defaults to *outliers*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "outliers",
- "suspectedoutliers",
- false
- ],
- "magic_underscores": "fig.update_traces(boxpoints=<VALUE>, selector=dict(type='box'))"
- },
- "notched": {
- "description": "Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to *false* unless `notchwidth` or `notchspan` is set.",
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(notched=<VALUE>, selector=dict(type='box'))"
- },
- "notchwidth": {
- "description": "Sets the width of the notches relative to the box width. For example, with 0, the notches are as wide as the box(es).",
- "dflt": 0.25,
- "editType": "calc",
- "max": 0.5,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(notchwidth=<VALUE>, selector=dict(type='box'))"
- },
- "showwhiskers": {
- "description": "Determines whether or not whiskers are visible. Defaults to true for `sizemode` *quartiles*, false for *sd*.",
- "editType": "calc",
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showwhiskers=<VALUE>, selector=dict(type='box'))"
- },
- "whiskerwidth": {
- "description": "Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).",
- "dflt": 0.5,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(whiskerwidth=<VALUE>, selector=dict(type='box'))"
- },
- "q1": {
- "description": "Sets the Quartile 1 values. There should be as many items as the number of boxes desired.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(q1=<VALUE>, selector=dict(type='box'))"
- },
- "median": {
- "description": "Sets the median values. There should be as many items as the number of boxes desired.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(median=<VALUE>, selector=dict(type='box'))"
- },
- "q3": {
- "description": "Sets the Quartile 3 values. There should be as many items as the number of boxes desired.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(q3=<VALUE>, selector=dict(type='box'))"
- },
- "lowerfence": {
- "description": "Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(lowerfence=<VALUE>, selector=dict(type='box'))"
- },
- "upperfence": {
- "description": "Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the upper as the last sample point above 1.5 times the IQR.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(upperfence=<VALUE>, selector=dict(type='box'))"
- },
- "notchspan": {
- "description": "Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(notchspan=<VALUE>, selector=dict(type='box'))"
- },
- "mean": {
- "description": "Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(mean=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='box'))"
},
- "sd": {
- "description": "Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(sd=<VALUE>, selector=dict(type='box'))"
+ "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",
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='box'))"
},
- "sdmultiple": {
- "description": "Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
+ "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",
- "magic_underscores": "fig.update_traces(sdmultiple=<VALUE>, selector=dict(type='box'))"
- },
- "quartilemethod": {
- "description": "Sets the method used to compute the sample's Q1 and Q3 quartiles. The *linear* method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The *exclusive* method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The *inclusive* method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.",
- "dflt": "linear",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "linear",
- "exclusive",
- "inclusive"
- ],
- "magic_underscores": "fig.update_traces(quartilemethod=<VALUE>, selector=dict(type='box'))"
- },
- "q1src": {
- "description": "Sets the source reference on Chart Studio Cloud for `q1`.",
- "editType": "none",
- "valType": "string"
- },
- "mediansrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `median`.",
- "editType": "none",
- "valType": "string"
- },
- "q3src": {
- "description": "Sets the source reference on Chart Studio Cloud for `q3`.",
- "editType": "none",
- "valType": "string"
- },
- "lowerfencesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lowerfence`.",
- "editType": "none",
- "valType": "string"
- },
- "upperfencesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `upperfence`.",
- "editType": "none",
- "valType": "string"
- },
- "notchspansrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `notchspan`.",
- "editType": "none",
- "valType": "string"
- },
- "meansrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `mean`.",
- "editType": "none",
- "valType": "string"
- },
- "sdsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `sd`.",
- "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",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='box'))"
},
- "selected": {
+ "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",
- "marker": {
- "color": {
- "description": "Sets the marker color of selected points.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='box'))"
- },
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='box'))"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of selected points.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='box'))"
- },
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='box'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='box'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='box'))"
},
- "unselected": {
+ "legendgrouptitle": {
"editType": "style",
- "marker": {
+ "font": {
"color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='box'))"
},
+ "description": "Sets this legend group's title font.",
"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",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='box'))"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of unselected points, applied only when a selection exists.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='box'))"
- },
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='box'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='box'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='box'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "none",
+ "editType": "style",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='box'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='box'))"
},
"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": "style",
"extras": [
"none"
],
@@ -35253,61 +32856,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='box'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='box'))"
},
"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",
+ "editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='box'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='box'))"
},
"size": {
- "arrayOk": true,
- "editType": "none",
+ "editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='box'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='box'))"
},
"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": "style",
"valType": "enumerated",
"values": [
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='box'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='box'))"
},
"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": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -35315,18 +32894,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='box'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='box'))"
},
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -35336,18 +32909,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='box'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='box'))"
},
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "style",
"extras": [
"normal",
"bold"
@@ -35355,442 +32922,92 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='box'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='box'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='box'))"
},
"role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='box'))"
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='box'))"
},
- "hoveron": {
- "description": "Do the hover effects highlight individual boxes or sample points or both?",
- "dflt": "boxes+points",
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
- "flags": [
- "boxes",
- "points"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoveron=<VALUE>, selector=dict(type='box'))"
- },
- "pointpos": {
- "description": "Sets the position of the sample points in relation to the box(es). If *0*, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes",
- "editType": "calc",
- "max": 2,
- "min": -2,
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(pointpos=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='box'))"
},
- "jitter": {
- "description": "Sets the amount of jitter in the sample points drawn. If *0*, the sample points align along the distribution axis. If *1*, the sample points are drawn in a random jitter of width equal to the width of the box(es).",
- "editType": "calc",
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(jitter=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='box'))"
},
- "sizemode": {
- "description": "Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc",
- "dflt": "quartiles",
+ "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": "enumerated",
- "values": [
- "quartiles",
- "sd"
- ],
- "magic_underscores": "fig.update_traces(sizemode=<VALUE>, selector=dict(type='box'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='box'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='box'))"
+ "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",
+ "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='box'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='box'))"
+ "x": {
+ "description": "Sets the x sample data or coordinates. See overview for more info.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='box'))"
},
- "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",
+ "x0": {
+ "description": "Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
+ "editType": "calc+clearAxisTypes",
"valType": "any",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='box'))"
+ "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='box'))"
},
- "stream": {
+ "dx": {
+ "description": "Sets the x coordinate step for multi-box traces set using q1/median/q3.",
"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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='box'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='box'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='box'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(dx=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='box'))"
- },
- "categories": [
- "cartesian",
- "svg",
- "symbols",
- "oriented",
- "box-violin",
- "showLegend",
- "boxLayout",
- "zoomScale"
- ],
- "layoutAttributes": {
- "boxgap": {
- "description": "Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have *width* set.",
- "dflt": 0.3,
+ "y": {
+ "description": "Sets the y sample data or coordinates. See overview for more info.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='box'))"
+ },
+ "y0": {
+ "description": "Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='box'))"
+ },
+ "dy": {
+ "description": "Sets the y coordinate step for multi-box traces set using q1/median/q3.",
"editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(dy=<VALUE>, selector=dict(type='box'))"
},
- "boxgroupgap": {
- "description": "Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have *width* set.",
- "dflt": 0.3,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "boxmode": {
- "description": "Determines how boxes at the same location coordinate are displayed on the graph. If *group*, the boxes are plotted next to one another centered around the shared location. If *overlay*, the boxes are plotted over one another, you might need to set *opacity* to see them multiple boxes. Has no effect on traces that have *width* set.",
- "dflt": "overlay",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "group",
- "overlay"
- ]
- }
- },
- "meta": {
- "description": "Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2, i.e. the median) is marked by a line inside the box. The fences grow outward from the boxes' edges, by default they span +/- 1.5 times the interquartile range (IQR: Q3-Q1), The sample mean and standard deviation as well as notches and the sample, outlier and suspected outliers points can be optionally added to the box plot. The values and positions corresponding to each boxes can be input using two signatures. The first signature expects users to supply the sample values in the `y` data array for vertical boxes (`x` for horizontal boxes). By supplying an `x` (`y`) array, one box per distinct `x` (`y`) value is drawn If no `x` (`y`) {array} is provided, a single box is drawn. In this case, the box is positioned with the trace `name` or with `x0` (`y0`) if provided. The second signature expects users to supply the boxes corresponding Q1, median and Q3 statistics in the `q1`, `median` and `q3` data arrays respectively. Other box features relying on statistics namely `lowerfence`, `upperfence`, `notchspan` can be set directly by the users. To have plotly compute them or to show sample points besides the boxes, users can set the `y` data array for vertical boxes (`x` for horizontal boxes) to a 2D array with the outer length corresponding to the number of boxes in the traces and the inner length corresponding the sample size."
- },
- "type": "box"
- },
- "violin": {
- "animatable": false,
- "attributes": {
- "type": "violin",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details).",
- "editType": "calc+clearAxisTypes",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='violin'))"
- },
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='violin'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='violin'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='violin'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='violin'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='violin'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='violin'))"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='violin'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='violin'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='violin'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='violin'))"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='violin'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='violin'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='violin'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='violin'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='violin'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='violin'))"
- },
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='violin'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='violin'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='violin'))"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='violin'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='violin'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
- "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='violin'))"
- },
- "x": {
- "description": "Sets the x sample data or coordinates. See overview for more info.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='violin'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "x0": {
- "description": "Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
- "editType": "calc+clearAxisTypes",
- "valType": "any",
- "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='violin'))"
- },
- "y": {
- "description": "Sets the y sample data or coordinates. See overview for more info.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='violin'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "y0": {
- "description": "Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
- "editType": "calc+clearAxisTypes",
- "valType": "any",
- "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='violin'))"
- },
- "width": {
- "description": "Sets the width of the violin in data coordinates. If *0* (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.",
- "dflt": 0,
+ "width": {
+ "description": "Sets the width of the box in data coordinate If *0* (default value) the width is automatically selected based on the positions of other box traces in the same subplot.",
+ "dflt": 0,
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='box'))"
},
"text": {
"arrayOk": true,
@@ -35798,12 +33015,7 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='violin'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='box'))"
},
"hovertext": {
"arrayOk": true,
@@ -35811,16 +33023,11 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='violin'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='box'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -35836,12 +33043,7 @@
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='violin'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='box'))"
},
"hovertemplate": {
"arrayOk": true,
@@ -35849,94 +33051,129 @@
"dflt": "",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='box'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "none",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='violin'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='box'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='box'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='box'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='violin'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='box'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='violin'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='box'))"
},
"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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='box'))"
},
"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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='box'))"
},
"orientation": {
- "description": "Sets the orientation of the violin(s). If *v* (*h*), the distribution is visualized along the vertical (horizontal).",
+ "description": "Sets the orientation of the box(es). If *v* (*h*), the distribution is visualized along the vertical (horizontal).",
"editType": "calc+clearAxisTypes",
"valType": "enumerated",
"values": [
"v",
"h"
],
- "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='box'))"
},
"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",
- "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='box'))"
},
"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",
- "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='box'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='box'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='box'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='box'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yperiod=<VALUE>, selector=dict(type='box'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(yperiodalignment=<VALUE>, selector=dict(type='box'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yperiod0=<VALUE>, selector=dict(type='box'))"
},
"marker": {
"angle": {
@@ -35945,14 +33182,14 @@
"dflt": 0,
"editType": "calc",
"valType": "angle",
- "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='box'))"
},
"color": {
"arrayOk": false,
"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",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='box'))"
},
"editType": "plot",
"line": {
@@ -35962,14 +33199,14 @@
"dflt": "#444",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='box'))"
},
"editType": "style",
"outliercolor": {
"description": "Sets the border line color of the outlier sample points. Defaults to marker.color",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_line_outliercolor=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_line_outliercolor=<VALUE>, selector=dict(type='box'))"
},
"outlierwidth": {
"description": "Sets the border line width (in px) of the outlier sample points.",
@@ -35977,7 +33214,7 @@
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_outlierwidth=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_line_outlierwidth=<VALUE>, selector=dict(type='box'))"
},
"role": "object",
"width": {
@@ -35987,9 +33224,9 @@
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='box'))"
},
"opacity": {
"arrayOk": false,
@@ -35999,14 +33236,14 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='box'))"
},
"outliercolor": {
"description": "Sets the color of the outlier sample points.",
"dflt": "rgba(0, 0, 0, 0)",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_outliercolor=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_outliercolor=<VALUE>, selector=dict(type='box'))"
},
"role": "object",
"size": {
@@ -36016,7 +33253,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='box'))"
},
"symbol": {
"arrayOk": false,
@@ -36512,166 +33749,223 @@
"154",
"arrow-wide-open"
],
- "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='box'))"
},
"line": {
"color": {
- "description": "Sets the color of line bounding the violin(s).",
+ "description": "Sets the color of line bounding the box(es).",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='box'))"
},
"editType": "plot",
"role": "object",
"width": {
- "description": "Sets the width (in px) of line bounding the violin(s).",
+ "description": "Sets the width (in px) of line bounding the box(es).",
"dflt": 2,
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='box'))"
},
- "box": {
- "editType": "plot",
- "fillcolor": {
- "description": "Sets the inner box plot fill color.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(box_fillcolor=<VALUE>, selector=dict(type='violin'))"
- },
- "line": {
- "color": {
- "description": "Sets the inner box plot bounding line color.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(box_line_color=<VALUE>, selector=dict(type='violin'))"
- },
- "editType": "style",
- "role": "object",
- "width": {
- "description": "Sets the inner box plot bounding line width.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(box_line_width=<VALUE>, selector=dict(type='violin'))"
- },
- "magic_underscores": "fig.update_traces(box_line=dict(...), selector=dict(type='violin'))"
- },
- "role": "object",
- "visible": {
- "description": "Determines if an miniature box plot is drawn inside the violins. ",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(box_visible=<VALUE>, selector=dict(type='violin'))"
- },
- "width": {
- "description": "Sets the width of the inner box plots relative to the violins' width. For example, with 1, the inner box plots are as wide as the violins.",
- "dflt": 0.25,
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(box_width=<VALUE>, selector=dict(type='violin'))"
- },
- "magic_underscores": "fig.update_traces(box=dict(...), selector=dict(type='violin'))"
+ "boxmean": {
+ "description": "If *true*, the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If *sd* the standard deviation is also drawn. Defaults to *true* when `mean` is set. Defaults to *sd* when `sd` is set Otherwise defaults to *false*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ true,
+ "sd",
+ false
+ ],
+ "magic_underscores": "fig.update_traces(boxmean=<VALUE>, selector=dict(type='box'))"
},
- "quartilemethod": {
- "description": "Sets the method used to compute the sample's Q1 and Q3 quartiles. The *linear* method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The *exclusive* method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The *inclusive* method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.",
- "dflt": "linear",
+ "boxpoints": {
+ "description": "If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the box(es) are shown with no sample points Defaults to *suspectedoutliers* when `marker.outliercolor` or `marker.line.outliercolor` is set. Defaults to *all* under the q1/median/q3 signature. Otherwise defaults to *outliers*.",
"editType": "calc",
"valType": "enumerated",
"values": [
- "linear",
- "exclusive",
- "inclusive"
+ "all",
+ "outliers",
+ "suspectedoutliers",
+ false
],
- "magic_underscores": "fig.update_traces(quartilemethod=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(boxpoints=<VALUE>, selector=dict(type='box'))"
},
- "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.",
+ "notched": {
+ "description": "Determines whether or not notches are drawn. Notches displays a confidence interval around the median. We compute the confidence interval as median +/- 1.57 * IQR / sqrt(N), where IQR is the interquartile range and N is the sample size. If two boxes' notches do not overlap there is 95% confidence their medians differ. See https://sites.google.com/site/davidsstatistics/home/notched-box-plots for more info. Defaults to *false* unless `notchwidth` or `notchspan` is set.",
"editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='violin'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(notched=<VALUE>, selector=dict(type='box'))"
},
- "selected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of selected points.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='violin'))"
- },
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='violin'))"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of selected points.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='violin'))"
- },
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='violin'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='violin'))"
+ "notchwidth": {
+ "description": "Sets the width of the notches relative to the box width. For example, with 0, the notches are as wide as the box(es).",
+ "dflt": 0.25,
+ "editType": "calc",
+ "max": 0.5,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(notchwidth=<VALUE>, selector=dict(type='box'))"
},
- "unselected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='violin'))"
- },
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "showwhiskers": {
+ "description": "Determines whether or not whiskers are visible. Defaults to true for `sizemode` *quartiles*, false for *sd*.",
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showwhiskers=<VALUE>, selector=dict(type='box'))"
+ },
+ "whiskerwidth": {
+ "description": "Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).",
+ "dflt": 0.5,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(whiskerwidth=<VALUE>, selector=dict(type='box'))"
+ },
+ "q1": {
+ "description": "Sets the Quartile 1 values. There should be as many items as the number of boxes desired.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(q1=<VALUE>, selector=dict(type='box'))"
+ },
+ "median": {
+ "description": "Sets the median values. There should be as many items as the number of boxes desired.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(median=<VALUE>, selector=dict(type='box'))"
+ },
+ "q3": {
+ "description": "Sets the Quartile 3 values. There should be as many items as the number of boxes desired.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(q3=<VALUE>, selector=dict(type='box'))"
+ },
+ "lowerfence": {
+ "description": "Sets the lower fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `lowerfence` is not provided but a sample (in `y` or `x`) is set, we compute the lower as the last sample point below 1.5 times the IQR.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(lowerfence=<VALUE>, selector=dict(type='box'))"
+ },
+ "upperfence": {
+ "description": "Sets the upper fence values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `upperfence` is not provided but a sample (in `y` or `x`) is set, we compute the upper as the last sample point above 1.5 times the IQR.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(upperfence=<VALUE>, selector=dict(type='box'))"
+ },
+ "notchspan": {
+ "description": "Sets the notch span from the boxes' `median` values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `notchspan` is not provided but a sample (in `y` or `x`) is set, we compute it as 1.57 * IQR / sqrt(N), where N is the sample size.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(notchspan=<VALUE>, selector=dict(type='box'))"
+ },
+ "mean": {
+ "description": "Sets the mean values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `mean` is not provided but a sample (in `y` or `x`) is set, we compute the mean for each box using the sample values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(mean=<VALUE>, selector=dict(type='box'))"
+ },
+ "sd": {
+ "description": "Sets the standard deviation values. There should be as many items as the number of boxes desired. This attribute has effect only under the q1/median/q3 signature. If `sd` is not provided but a sample (in `y` or `x`) is set, we compute the standard deviation for each box using the sample values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(sd=<VALUE>, selector=dict(type='box'))"
+ },
+ "sdmultiple": {
+ "description": "Scales the box size when sizemode=sd Allowing boxes to be drawn across any stddev range For example 1-stddev, 3-stddev, 5-stddev",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(sdmultiple=<VALUE>, selector=dict(type='box'))"
+ },
+ "quartilemethod": {
+ "description": "Sets the method used to compute the sample's Q1 and Q3 quartiles. The *linear* method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The *exclusive* method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The *inclusive* method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.",
+ "dflt": "linear",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "linear",
+ "exclusive",
+ "inclusive"
+ ],
+ "magic_underscores": "fig.update_traces(quartilemethod=<VALUE>, selector=dict(type='box'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='box'))"
+ },
+ "selected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of selected points.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='box'))"
+ },
+ "editType": "style",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
"editType": "style",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='box'))"
},
"role": "object",
"size": {
- "description": "Sets the marker size of unselected points, applied only when a selection exists.",
+ "description": "Sets the marker size of selected points.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='box'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='box'))"
},
- "bandwidth": {
- "description": "Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.",
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(bandwidth=<VALUE>, selector=dict(type='violin'))"
+ "unselected": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='box'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='box'))"
+ },
+ "role": "object",
+ "size": {
+ "description": "Sets the marker size of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='box'))"
+ },
+ "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='box'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='box'))"
},
"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",
- "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='box'))"
},
"hoverlabel": {
"align": {
@@ -36685,36 +33979,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='violin'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='box'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='violin'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='box'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='violin'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='box'))"
},
"editType": "none",
"font": {
@@ -36722,12 +34001,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='violin'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='box'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -36738,12 +34012,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='violin'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='box'))"
},
"lineposition": {
"arrayOk": true,
@@ -36759,12 +34028,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='violin'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='box'))"
},
"role": "object",
"shadow": {
@@ -36773,24 +34037,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='violin'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='box'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='violin'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='box'))"
},
"style": {
"arrayOk": true,
@@ -36802,12 +34056,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='violin'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='box'))"
},
"textcase": {
"arrayOk": true,
@@ -36821,12 +34070,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='violin'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='box'))"
},
"variant": {
"arrayOk": true,
@@ -36842,12 +34086,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='violin'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='box'))"
},
"weight": {
"arrayOk": true,
@@ -36861,14 +34100,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='violin'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='box'))"
},
"namelength": {
"arrayOk": true,
@@ -36877,12 +34111,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='violin'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='box'))"
},
"role": "object",
"showarrow": {
@@ -36890,165 +34119,105 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='box'))"
},
"hoveron": {
- "description": "Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?",
- "dflt": "violins+points+kde",
+ "description": "Do the hover effects highlight individual boxes or sample points or both?",
+ "dflt": "boxes+points",
"editType": "style",
- "extras": [
- "all"
- ],
"flags": [
- "violins",
- "points",
- "kde"
+ "boxes",
+ "points"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoveron=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(hoveron=<VALUE>, selector=dict(type='box'))"
},
"pointpos": {
- "description": "Sets the position of the sample points in relation to the violins. If *0*, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.",
+ "description": "Sets the position of the sample points in relation to the box(es). If *0*, the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes",
"editType": "calc",
"max": 2,
"min": -2,
"valType": "number",
- "magic_underscores": "fig.update_traces(pointpos=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(pointpos=<VALUE>, selector=dict(type='box'))"
},
"jitter": {
- "description": "Sets the amount of jitter in the sample points drawn. If *0*, the sample points align along the distribution axis. If *1*, the sample points are drawn in a random jitter of width equal to the width of the violins.",
+ "description": "Sets the amount of jitter in the sample points drawn. If *0*, the sample points align along the distribution axis. If *1*, the sample points are drawn in a random jitter of width equal to the width of the box(es).",
"editType": "calc",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(jitter=<VALUE>, selector=dict(type='violin'))"
- },
- "meanline": {
- "color": {
- "description": "Sets the mean line color.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(meanline_color=<VALUE>, selector=dict(type='violin'))"
- },
- "editType": "plot",
- "role": "object",
- "visible": {
- "description": "Determines if a line corresponding to the sample's mean is shown inside the violins. If `box.visible` is turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(meanline_visible=<VALUE>, selector=dict(type='violin'))"
- },
- "width": {
- "description": "Sets the mean line width.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(meanline_width=<VALUE>, selector=dict(type='violin'))"
- },
- "magic_underscores": "fig.update_traces(meanline=dict(...), selector=dict(type='violin'))"
- },
- "points": {
- "description": "If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the violins are shown with no sample points. Defaults to *suspectedoutliers* when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to *outliers*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "outliers",
- "suspectedoutliers",
- false
- ],
- "magic_underscores": "fig.update_traces(points=<VALUE>, selector=dict(type='violin'))"
- },
- "scalegroup": {
- "description": "If there are multiple violins that should be sized according to to some metric (see `scalemode`), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(scalegroup=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(jitter=<VALUE>, selector=dict(type='box'))"
},
- "scalemode": {
- "description": "Sets the metric by which the width of each violin is determined. *width* means each violin has the same (max) width *count* means the violins are scaled by the number of sample points making up each violin.",
- "dflt": "width",
+ "sizemode": {
+ "description": "Sets the upper and lower bound for the boxes quartiles means box is drawn between Q1 and Q3 SD means the box is drawn between Mean +- Standard Deviation Argument sdmultiple (default 1) to scale the box size So it could be drawn 1-stddev, 3-stddev etc",
+ "dflt": "quartiles",
"editType": "calc",
"valType": "enumerated",
"values": [
- "width",
- "count"
+ "quartiles",
+ "sd"
],
- "magic_underscores": "fig.update_traces(scalemode=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(sizemode=<VALUE>, selector=dict(type='box'))"
},
- "side": {
- "description": "Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under *overlay* mode, where one trace has `side` set to *positive* and the other to *negative*.",
- "dflt": "both",
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
"editType": "calc",
"valType": "enumerated",
"values": [
- "both",
- "positive",
- "negative"
- ],
- "magic_underscores": "fig.update_traces(side=<VALUE>, selector=dict(type='violin'))"
- },
- "span": {
- "description": "Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to *manual*.",
- "editType": "calc",
- "items": [
- {
- "editType": "calc",
- "valType": "any"
- },
- {
- "editType": "calc",
- "valType": "any"
- }
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
],
- "valType": "info_array",
- "magic_underscores": "fig.update_traces(span=list(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='box'))"
},
- "spanmode": {
- "description": "Sets the method by which the span in data space where the density function will be computed. *soft* means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. *hard* means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode *manual* and fill in the `span` attribute.",
- "dflt": "soft",
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
"editType": "calc",
"valType": "enumerated",
"values": [
- "soft",
- "hard",
- "manual"
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
],
- "magic_underscores": "fig.update_traces(spanmode=<VALUE>, selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='box'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='violin'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='violin'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='violin'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='box'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='violin'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='box'))"
},
"categories": [
"cartesian",
@@ -37057,28 +34226,28 @@
"oriented",
"box-violin",
"showLegend",
- "violinLayout",
+ "boxLayout",
"zoomScale"
],
"layoutAttributes": {
- "violingap": {
- "description": "Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have *width* set.",
+ "boxgap": {
+ "description": "Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have *width* set.",
"dflt": 0.3,
"editType": "calc",
"max": 1,
"min": 0,
"valType": "number"
},
- "violingroupgap": {
- "description": "Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have *width* set.",
+ "boxgroupgap": {
+ "description": "Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have *width* set.",
"dflt": 0.3,
"editType": "calc",
"max": 1,
"min": 0,
"valType": "number"
},
- "violinmode": {
- "description": "Determines how violins at the same location coordinate are displayed on the graph. If *group*, the violins are plotted next to one another centered around the shared location. If *overlay*, the violins are plotted over one another, you might need to set *opacity* to see them multiple violins. Has no effect on traces that have *width* set.",
+ "boxmode": {
+ "description": "Determines how boxes at the same location coordinate are displayed on the graph. If *group*, the boxes are plotted next to one another centered around the shared location. If *overlay*, the boxes are plotted over one another, you might need to set *opacity* to see them multiple boxes. Has no effect on traces that have *width* set.",
"dflt": "overlay",
"editType": "calc",
"valType": "enumerated",
@@ -37089,25 +34258,25 @@
}
},
"meta": {
- "description": "In vertical (horizontal) violin plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one violin per distinct x (y) value is drawn If no `x` (`y`) {array} is provided, a single violin is drawn. That violin position is then positioned with with `name` or with `x0` (`y0`) if provided."
+ "description": "Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2, i.e. the median) is marked by a line inside the box. The fences grow outward from the boxes' edges, by default they span +/- 1.5 times the interquartile range (IQR: Q3-Q1), The sample mean and standard deviation as well as notches and the sample, outlier and suspected outliers points can be optionally added to the box plot. The values and positions corresponding to each boxes can be input using two signatures. The first signature expects users to supply the sample values in the `y` data array for vertical boxes (`x` for horizontal boxes). By supplying an `x` (`y`) array, one box per distinct `x` (`y`) value is drawn If no `x` (`y`) {array} is provided, a single box is drawn. In this case, the box is positioned with the trace `name` or with `x0` (`y0`) if provided. The second signature expects users to supply the boxes corresponding Q1, median and Q3 statistics in the `q1`, `median` and `q3` data arrays respectively. Other box features relying on statistics namely `lowerfence`, `upperfence`, `notchspan` can be set directly by the users. To have plotly compute them or to show sample points besides the boxes, users can set the `y` data array for vertical boxes (`x` for horizontal boxes) to a 2D array with the outer length corresponding to the number of boxes in the traces and the inner length corresponding the sample size."
},
- "type": "violin"
+ "type": "box"
},
- "histogram": {
+ "violin": {
"animatable": false,
"attributes": {
- "type": "histogram",
+ "type": "violin",
"name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover. For violin traces, the name will also be used for the position coordinate, if `x` and `x0` (`y` and `y0` if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute `scalegroup` (please see its description for details).",
+ "editType": "calc+clearAxisTypes",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='violin'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='violin'))"
},
"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).",
@@ -37119,35 +34288,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='violin'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": true,
"editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='violin'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -37155,7 +34324,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='violin'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -37165,7 +34334,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='violin'))"
},
"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.",
@@ -37180,7 +34349,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='violin'))"
},
"role": "object",
"shadow": {
@@ -37188,13 +34357,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='violin'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='violin'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -37205,7 +34374,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='violin'))"
},
"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.",
@@ -37218,7 +34387,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='violin'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -37233,7 +34402,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='violin'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -37246,9 +34415,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='violin'))"
},
"role": "object",
"text": {
@@ -37256,16 +34425,16 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='violin'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='violin'))"
},
"opacity": {
"description": "Sets the opacity of the trace.",
@@ -37274,105 +34443,72 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='histogram'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='violin'))"
},
"x": {
- "description": "Sets the sample data to be binned on the x axis.",
+ "description": "Sets the x sample data or coordinates. See overview for more info.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='violin'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
+ "x0": {
+ "description": "Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='violin'))"
},
"y": {
- "description": "Sets the sample data to be binned on the y axis.",
+ "description": "Sets the y sample data or coordinates. See overview for more info.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='violin'))"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
+ "y0": {
+ "description": "Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='violin'))"
+ },
+ "width": {
+ "description": "Sets the width of the violin in data coordinates. If *0* (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='violin'))"
},
"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.",
+ "description": "Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='histogram'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='violin'))"
},
- "texttemplate": {
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`.",
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Same as `text`.",
"dflt": "",
- "editType": "plot",
+ "editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='histogram'))"
- },
- "texttemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "plot",
- "valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='histogram'))"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='histogram'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='violin'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -37388,6411 +34524,822 @@
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='histogram'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='violin'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='violin'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "none",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='histogram'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='violin'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='violin'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='histogram'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='histogram'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='violin'))"
},
"orientation": {
- "description": "Sets the orientation of the bars. With *v* (*h*), the value of the each bar spans along the vertical (horizontal).",
+ "description": "Sets the orientation of the violin(s). If *v* (*h*), the distribution is visualized along the vertical (horizontal).",
"editType": "calc+clearAxisTypes",
"valType": "enumerated",
"values": [
"v",
"h"
],
- "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(histfunc=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(histnorm=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(nbinsx=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(nbinsy=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(autobinx=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(autobiny=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(bingroup=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_end=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_start=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(xbins=dict(...), selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_end=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_start=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(ybins=dict(...), selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='violin'))"
},
"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": {
- "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='histogram'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='histogram'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='histogram'))"
- },
- "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,
+ "angle": {
+ "arrayOk": false,
+ "description": "Sets the marker angle in respect to `angleref`.",
+ "dflt": 0,
"editType": "calc",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='histogram'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='histogram'))"
+ "valType": "angle",
+ "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='violin'))"
},
"color": {
- "arrayOk": true,
+ "arrayOk": false,
"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",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='violin'))"
},
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='histogram'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
+ "editType": "plot",
+ "line": {
+ "color": {
+ "arrayOk": false,
+ "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": "colorbars",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='histogram'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='histogram'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='histogram'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='histogram'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='violin'))"
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
+ "editType": "style",
+ "outliercolor": {
+ "description": "Sets the border line color of the outlier sample points. Defaults to marker.color",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(marker_line_outliercolor=<VALUE>, selector=dict(type='violin'))"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
+ "outlierwidth": {
+ "description": "Sets the border line width (in px) of the outlier sample points.",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(marker_line_outlierwidth=<VALUE>, selector=dict(type='violin'))"
},
"role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='histogram'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='histogram'))"
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='histogram'))"
- },
- "thickness": {
- "description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
- "dflt": 30,
- "editType": "colorbars",
+ "width": {
+ "arrayOk": false,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "dflt": 0,
+ "editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='histogram'))"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='violin'))"
},
- "tickfont": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='histogram'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='histogram'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='histogram'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='histogram'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='histogram'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- ""
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='histogram'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='histogram'))"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='histogram'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='histogram'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='histogram'))"
- },
- "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*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='histogram'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='histogram'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='histogram'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='histogram'))"
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='violin'))"
},
- "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,
- "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='histogram'))"
+ "opacity": {
+ "arrayOk": false,
+ "description": "Sets the marker opacity.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='violin'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "outliercolor": {
+ "description": "Sets the color of the outlier sample points.",
+ "dflt": "rgba(0, 0, 0, 0)",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_outliercolor=<VALUE>, selector=dict(type='violin'))"
},
- "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.",
+ "role": "object",
+ "size": {
+ "arrayOk": false,
+ "description": "Sets the marker size (in px).",
+ "dflt": 6,
"editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_cornerradius=<VALUE>, selector=dict(type='histogram'))"
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='violin'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_line_autocolorscale=<VALUE>, selector=dict(type='histogram'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_cauto_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_line_cauto=<VALUE>, selector=dict(type='histogram'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_cmax_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmax=<VALUE>, selector=dict(type='histogram'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_cmid_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmid=<VALUE>, selector=dict(type='histogram'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_cmin_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmin=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='histogram'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_colorscale_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_reversescale=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='histogram'))"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='histogram'))"
- },
- "opacity": {
- "arrayOk": true,
- "description": "Sets the opacity of the bars.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_pattern_fgopacity=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_pattern_fillmode=<VALUE>, selector=dict(type='histogram'))"
- },
- "path": {
- "arrayOk": true,
- "description": "Sets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='histogram'))"
- },
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "-",
- "|",
- "+",
- "."
- ],
- "magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='histogram'))"
- },
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(textangle=<VALUE>, selector=dict(type='histogram'))"
- },
- "textfont": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='histogram'))"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='histogram'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='histogram'))"
- },
- "error_x": {
- "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",
- "magic_underscores": "fig.update_traces(error_x_array=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_x_arrayminus=<VALUE>, selector=dict(type='histogram'))"
- },
- "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 stroke color of the error bars.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(error_x_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "copy_ystyle": {
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(error_x_copy_ystyle=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_x_symmetric=<VALUE>, selector=dict(type='histogram'))"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_x_thickness=<VALUE>, selector=dict(type='histogram'))"
- },
- "traceref": {
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_x_traceref=<VALUE>, selector=dict(type='histogram'))"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_x_tracerefminus=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(error_x_type=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_x_value=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_x_valueminus=<VALUE>, selector=dict(type='histogram'))"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(error_x_visible=<VALUE>, selector=dict(type='histogram'))"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "symbol": {
+ "arrayOk": false,
+ "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": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_x_width=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(error_x=dict(...), selector=dict(type='histogram'))"
- },
- "error_y": {
- "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",
- "magic_underscores": "fig.update_traces(error_y_array=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_y_arrayminus=<VALUE>, selector=dict(type='histogram'))"
- },
- "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 stroke color of the error bars.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(error_y_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_y_symmetric=<VALUE>, selector=dict(type='histogram'))"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_y_thickness=<VALUE>, selector=dict(type='histogram'))"
- },
- "traceref": {
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_y_traceref=<VALUE>, selector=dict(type='histogram'))"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_y_tracerefminus=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(error_y_type=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_y_value=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_y_valueminus=<VALUE>, selector=dict(type='histogram'))"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(error_y_visible=<VALUE>, selector=dict(type='histogram'))"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_y_width=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(error_y=dict(...), selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='histogram'))"
- },
- "selected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of selected points.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "editType": "style",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='histogram'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='histogram'))"
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of selected points.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(selected_textfont_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "editType": "style",
- "role": "object",
- "magic_underscores": "fig.update_traces(selected_textfont=dict(...), selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='histogram'))"
- },
- "unselected": {
- "editType": "style",
- "marker": {
- "color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='histogram'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='histogram'))"
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of unselected points, applied only when a selection exists.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(unselected_textfont_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "editType": "style",
- "role": "object",
- "magic_underscores": "fig.update_traces(unselected_textfont=dict(...), selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cliponaxis=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(constraintext=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(cumulative_currentbin=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(cumulative_direction=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cumulative_enabled=<VALUE>, selector=dict(type='histogram'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(cumulative=dict(...), selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='histogram'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='histogram'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(insidetextanchor=<VALUE>, selector=dict(type='histogram'))"
- },
- "insidetextfont": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='histogram'))"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='histogram'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='histogram'))"
- },
- "outsidetextfont": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='histogram'))"
- },
- "description": "Sets the font used for `text` lying outside the bar.",
- "editType": "plot",
- "family": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='histogram'))"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='histogram'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='histogram'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='histogram'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='histogram'))"
- },
- "magic_underscores": "fig.update_traces(..., selector=dict(type='histogram'))"
- },
- "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",
- "valType": "any"
- },
- "bargap": {
- "description": "Sets the gap (in plot fraction) between bars of adjacent location coordinates.",
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "bargroupgap": {
- "description": "Sets the gap (in plot fraction) between bars of the same location coordinate.",
- "dflt": 0,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "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"
- ]
- },
- "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"
- ]
- }
- },
- "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."
- },
- "type": "histogram"
- },
- "histogram2d": {
- "animatable": false,
- "attributes": {
- "type": "histogram2d",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='histogram2d'))"
- },
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='histogram2d'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "x": {
- "description": "Sets the sample data to be binned on the x axis.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "xgap": {
- "description": "Sets the horizontal gap (in pixels) between bricks.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(xgap=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "y": {
- "description": "Sets the sample data to be binned on the y axis.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "ygap": {
- "description": "Sets the vertical gap (in pixels) between bricks.",
- "dflt": 0,
- "editType": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(ygap=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "z": {
- "description": "Sets the aggregation data.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "texttemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "plot",
- "valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "none",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(histfunc=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(histnorm=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(nbinsx=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(nbinsy=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(autobinx=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(autobiny=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(bingroup=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbingroup=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_end=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_size=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_start=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(xbins=dict(...), selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybingroup=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_end=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_size=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_start=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(ybins=dict(...), selector=dict(type='histogram2d'))"
- },
- "marker": {
- "color": {
- "description": "Sets the aggregation data.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "role": "object",
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='histogram2d'))"
- },
- "textfont": {
- "color": {
- "dflt": "auto",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "size": {
- "dflt": "auto",
- "editType": "plot",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='histogram2d'))"
- },
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "tickfont": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- ""
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='histogram2d'))"
- },
- "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*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='histogram2d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "zsmooth": {
- "description": "Picks a smoothing algorithm use to smooth `z` data.",
- "dflt": false,
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "fast",
- "best",
- false
- ],
- "magic_underscores": "fig.update_traces(zsmooth=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='histogram2d'))"
- },
- "magic_underscores": "fig.update_traces(..., selector=dict(type='histogram2d'))"
- },
- "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": {
- "type": "histogram2dcontour",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "x": {
- "description": "Sets the sample data to be binned on the x axis.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "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 appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "texttemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "plot",
- "valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "none",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(histfunc=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(histnorm=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(nbinsx=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(nbinsy=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(autobinx=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(autobiny=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(bingroup=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbingroup=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_end=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xbins_start=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(xbins=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybingroup=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_end=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ybins_start=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(ybins=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "marker": {
- "color": {
- "description": "Sets the aggregation data.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
- "editType": "calc",
- "role": "object",
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(line_dash=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(line_smoothing=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "width": {
- "description": "Sets the contour line width in (in px)",
- "dflt": 0.5,
- "editType": "style+colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "textfont": {
- "color": {
- "dflt": "auto",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "size": {
- "dflt": "auto",
- "editType": "plot",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "tickfont": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- ""
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(autocontour_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(autocontour=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(contours_coloring=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "editType": "calc",
- "end": {
- "description": "Sets the end contour level value. Must be more than `contours.start`",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "^autocontour": false,
- "magic_underscores": "fig.update_traces(contours_end_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_end=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "impliedEdits": {
- "autocontour": false,
- "role": "object",
- "magic_underscores": "fig.update_traces(contours_impliedEdits=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "labelfont": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(contours_labelfont_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(contours_labelfont_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(contours_labelfont_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(contours_labelfont_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_labelfont_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(contours_labelfont_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(contours_labelfont_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(contours_labelfont_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(contours_labelfont_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(contours_labelfont=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(contours_labelformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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": [
- "=",
- "<",
- ">=",
- ">",
- "<=",
- "[]",
- "()",
- "[)",
- "(]",
- "][",
- ")(",
- "](",
- ")["
- ],
- "magic_underscores": "fig.update_traces(contours_operation=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "role": "object",
- "showlabels": {
- "description": "Determines whether to label the contour lines with their values.",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_showlabels=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(contours_showlines=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "size": {
- "description": "Sets the step between each contour level. Must be positive.",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "^autocontour": false,
- "magic_underscores": "fig.update_traces(contours_size_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "start": {
- "description": "Sets the starting contour level value. Must be less than `contours.end`",
- "dflt": null,
- "editType": "plot",
- "impliedEdits": {
- "^autocontour": false,
- "magic_underscores": "fig.update_traces(contours_start_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_start=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(contours_type=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(contours_value=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(contours=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ncontours=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='histogram2dcontour'))"
- },
- "magic_underscores": "fig.update_traces(..., selector=dict(type='histogram2dcontour'))"
- },
- "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"
- },
- "ohlc": {
- "animatable": false,
- "attributes": {
- "type": "ohlc",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='ohlc'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='ohlc'))"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='ohlc'))"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='ohlc'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='ohlc'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='ohlc'))"
+ 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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='violin'))"
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='violin'))"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the color of line bounding the violin(s).",
"editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='ohlc'))"
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='ohlc'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='ohlc'))"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='ohlc'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
- "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='ohlc'))"
- },
- "x": {
- "description": "Sets the x coordinates. If absent, linear coordinate will be generated.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='ohlc'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "close": {
- "description": "Sets the close values.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(close=<VALUE>, selector=dict(type='ohlc'))"
- },
- "closesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `close`.",
- "editType": "none",
- "valType": "string"
- },
- "open": {
- "description": "Sets the open values.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(open=<VALUE>, selector=dict(type='ohlc'))"
- },
- "opensrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `open`.",
- "editType": "none",
- "valType": "string"
- },
- "high": {
- "description": "Sets the high values.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(high=<VALUE>, selector=dict(type='ohlc'))"
- },
- "highsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `high`.",
- "editType": "none",
- "valType": "string"
- },
- "low": {
- "description": "Sets the low values.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(low=<VALUE>, selector=dict(type='ohlc'))"
- },
- "lowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `low`.",
- "editType": "none",
- "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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='ohlc'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='ohlc'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='ohlc'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `open`, `high`, `low` and `close`. 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='ohlc'))"
- },
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "none",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='ohlc'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='ohlc'))"
+ "role": "object",
+ "width": {
+ "description": "Sets the width (in px) of line bounding the violin(s).",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='violin'))"
+ },
+ "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='violin'))"
},
- "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.",
+ "box": {
"editType": "plot",
- "valType": "any",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='ohlc'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='ohlc'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
+ "fillcolor": {
+ "description": "Sets the inner box plot fill color.",
"editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ],
- "magic_underscores": "fig.update_traces(line_dash=<VALUE>, selector=dict(type='ohlc'))"
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(box_fillcolor=<VALUE>, selector=dict(type='violin'))"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the inner box plot bounding line color.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(box_line_color=<VALUE>, selector=dict(type='violin'))"
+ },
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the inner box plot bounding line width.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(box_line_width=<VALUE>, selector=dict(type='violin'))"
+ },
+ "magic_underscores": "fig.update_traces(box_line=dict(...), selector=dict(type='violin'))"
},
- "editType": "style",
"role": "object",
+ "visible": {
+ "description": "Determines if an miniature box plot is drawn inside the violins. ",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(box_visible=<VALUE>, selector=dict(type='violin'))"
+ },
"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",
+ "description": "Sets the width of the inner box plots relative to the violins' width. For example, with 1, the inner box plots are as wide as the violins.",
+ "dflt": 0.25,
+ "editType": "plot",
+ "max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(box_width=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(box=dict(...), selector=dict(type='violin'))"
+ },
+ "quartilemethod": {
+ "description": "Sets the method used to compute the sample's Q1 and Q3 quartiles. The *linear* method uses the 25th percentile for Q1 and 75th percentile for Q3 as computed using method #10 (listed on http://jse.amstat.org/v14n3/langford.html). The *exclusive* method uses the median to divide the ordered dataset into two halves if the sample is odd, it does not include the median in either half - Q1 is then the median of the lower half and Q3 the median of the upper half. The *inclusive* method also uses the median to divide the ordered dataset into two halves but if the sample is odd, it includes the median in both halves - Q1 is then the median of the lower half and Q3 the median of the upper half.",
+ "dflt": "linear",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "linear",
+ "exclusive",
+ "inclusive"
+ ],
+ "magic_underscores": "fig.update_traces(quartilemethod=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='violin'))"
},
- "increasing": {
+ "selected": {
"editType": "style",
- "line": {
+ "marker": {
"color": {
- "description": "Sets the line color.",
- "dflt": "#3D9970",
+ "description": "Sets the marker color of selected points.",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(increasing_line_color=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='violin'))"
},
- "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",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
"editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ],
- "magic_underscores": "fig.update_traces(increasing_line_dash=<VALUE>, selector=dict(type='ohlc'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='violin'))"
},
- "editType": "style",
"role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
+ "size": {
+ "description": "Sets the marker size of selected points.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(increasing_line_width=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(increasing_line=dict(...), selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='violin'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(increasing=dict(...), selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='violin'))"
},
- "decreasing": {
+ "unselected": {
"editType": "style",
- "line": {
+ "marker": {
"color": {
- "description": "Sets the line color.",
- "dflt": "#FF4136",
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(decreasing_line_color=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='violin'))"
},
- "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",
+ "opacity": {
+ "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
"editType": "style",
- "valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
- ],
- "magic_underscores": "fig.update_traces(decreasing_line_dash=<VALUE>, selector=dict(type='ohlc'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='violin'))"
},
- "editType": "style",
"role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
+ "size": {
+ "description": "Sets the marker size of unselected points, applied only when a selection exists.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(decreasing_line_width=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(decreasing_line=dict(...), selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='violin'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(decreasing=dict(...), selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='violin'))"
+ },
+ "bandwidth": {
+ "description": "Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman's rule of thumb.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(bandwidth=<VALUE>, selector=dict(type='violin'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='violin'))"
},
"hoverlabel": {
"align": {
@@ -43806,36 +35353,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='ohlc'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='violin'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='ohlc'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='violin'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='ohlc'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='violin'))"
},
"editType": "none",
"font": {
@@ -43843,12 +35375,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='ohlc'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='violin'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -43859,12 +35386,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='ohlc'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='violin'))"
},
"lineposition": {
"arrayOk": true,
@@ -43880,12 +35402,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='ohlc'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='violin'))"
},
"role": "object",
"shadow": {
@@ -43894,24 +35411,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='ohlc'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='violin'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='ohlc'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='violin'))"
},
"style": {
"arrayOk": true,
@@ -43923,12 +35430,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='ohlc'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='violin'))"
},
"textcase": {
"arrayOk": true,
@@ -43942,12 +35444,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='ohlc'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='violin'))"
},
"variant": {
"arrayOk": true,
@@ -43963,12 +35460,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='ohlc'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='violin'))"
},
"weight": {
"arrayOk": true,
@@ -43982,14 +35474,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='ohlc'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='violin'))"
},
"namelength": {
"arrayOk": true,
@@ -43998,119 +35485,210 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='violin'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
+ "role": "object",
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
"editType": "none",
- "valType": "string"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='violin'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='violin'))"
+ },
+ "hoveron": {
+ "description": "Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?",
+ "dflt": "violins+points+kde",
+ "editType": "style",
+ "extras": [
+ "all"
+ ],
+ "flags": [
+ "violins",
+ "points",
+ "kde"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(hoveron=<VALUE>, selector=dict(type='violin'))"
+ },
+ "pointpos": {
+ "description": "Sets the position of the sample points in relation to the violins. If *0*, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.",
+ "editType": "calc",
+ "max": 2,
+ "min": -2,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(pointpos=<VALUE>, selector=dict(type='violin'))"
+ },
+ "jitter": {
+ "description": "Sets the amount of jitter in the sample points drawn. If *0*, the sample points align along the distribution axis. If *1*, the sample points are drawn in a random jitter of width equal to the width of the violins.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(jitter=<VALUE>, selector=dict(type='violin'))"
+ },
+ "meanline": {
+ "color": {
+ "description": "Sets the mean line color.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(meanline_color=<VALUE>, selector=dict(type='violin'))"
},
+ "editType": "plot",
"role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
+ "visible": {
+ "description": "Determines if a line corresponding to the sample's mean is shown inside the violins. If `box.visible` is turned on, the mean line is drawn inside the inner box. Otherwise, the mean line is drawn from one side of the violin to other.",
+ "dflt": false,
+ "editType": "plot",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(meanline_visible=<VALUE>, selector=dict(type='violin'))"
},
- "split": {
- "description": "Show hover information (open, close, high, low) in separate labels, rather than a single unified label. Default: *false*. When set to *true*, `hovertemplate` is ignored.",
- "dflt": false,
+ "width": {
+ "description": "Sets the mean line width.",
"editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_split=<VALUE>, selector=dict(type='ohlc'))"
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(meanline_width=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(meanline=dict(...), selector=dict(type='violin'))"
},
- "tickwidth": {
- "description": "Sets the width of the open/close tick marks relative to the *x* minimal interval.",
- "dflt": 0.3,
+ "points": {
+ "description": "If *outliers*, only the sample points lying outside the whiskers are shown If *suspectedoutliers*, the outlier points are shown and points either less than 4*Q1-3*Q3 or greater than 4*Q3-3*Q1 are highlighted (see `outliercolor`) If *all*, all sample points are shown If *false*, only the violins are shown with no sample points. Defaults to *suspectedoutliers* when `marker.outliercolor` or `marker.line.outliercolor` is set, otherwise defaults to *outliers*.",
"editType": "calc",
- "max": 0.5,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(tickwidth=<VALUE>, selector=dict(type='ohlc'))"
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "outliers",
+ "suspectedoutliers",
+ false
+ ],
+ "magic_underscores": "fig.update_traces(points=<VALUE>, selector=dict(type='violin'))"
},
- "xcalendar": {
- "description": "Sets the calendar system to use with `x` date data.",
- "dflt": "gregorian",
+ "scalegroup": {
+ "description": "If there are multiple violins that should be sized according to some metric (see `scalemode`), link them by providing a non-empty group id here shared by every trace in the same group. If a violin's `width` is undefined, `scalegroup` will default to the trace's name. In this case, violins with the same names will be linked together",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(scalegroup=<VALUE>, selector=dict(type='violin'))"
+ },
+ "scalemode": {
+ "description": "Sets the metric by which the width of each violin is determined. *width* means each violin has the same (max) width *count* means the violins are scaled by the number of sample points making up each violin.",
+ "dflt": "width",
"editType": "calc",
"valType": "enumerated",
"values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
+ "width",
+ "count"
],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(scalemode=<VALUE>, selector=dict(type='violin'))"
+ },
+ "side": {
+ "description": "Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under *overlay* mode, where one trace has `side` set to *positive* and the other to *negative*.",
+ "dflt": "both",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "both",
+ "positive",
+ "negative"
+ ],
+ "magic_underscores": "fig.update_traces(side=<VALUE>, selector=dict(type='violin'))"
+ },
+ "span": {
+ "description": "Sets the span in data space for which the density function will be computed. Has an effect only when `spanmode` is set to *manual*.",
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "valType": "any"
+ },
+ {
+ "editType": "calc",
+ "valType": "any"
+ }
+ ],
+ "valType": "info_array",
+ "magic_underscores": "fig.update_traces(span=list(...), selector=dict(type='violin'))"
+ },
+ "spanmode": {
+ "description": "Sets the method by which the span in data space where the density function will be computed. *soft* means the span goes from the sample's minimum value minus two bandwidths to the sample's maximum value plus two bandwidths. *hard* means the span goes from the sample's minimum to its maximum value. For custom span settings, use mode *manual* and fill in the `span` attribute.",
+ "dflt": "soft",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "soft",
+ "hard",
+ "manual"
+ ],
+ "magic_underscores": "fig.update_traces(spanmode=<VALUE>, selector=dict(type='violin'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='ohlc'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='ohlc'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='violin'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='ohlc'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='violin'))"
},
"categories": [
"cartesian",
"svg",
- "showLegend"
+ "symbols",
+ "oriented",
+ "box-violin",
+ "showLegend",
+ "violinLayout",
+ "zoomScale"
],
+ "layoutAttributes": {
+ "violingap": {
+ "description": "Sets the gap (in plot fraction) between violins of adjacent location coordinates. Has no effect on traces that have *width* set.",
+ "dflt": 0.3,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "violingroupgap": {
+ "description": "Sets the gap (in plot fraction) between violins of the same location coordinate. Has no effect on traces that have *width* set.",
+ "dflt": 0.3,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "violinmode": {
+ "description": "Determines how violins at the same location coordinate are displayed on the graph. If *group*, the violins are plotted next to one another centered around the shared location. If *overlay*, the violins are plotted over one another, you might need to set *opacity* to see them multiple violins. Has no effect on traces that have *width* set.",
+ "dflt": "overlay",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "group",
+ "overlay"
+ ]
+ }
+ },
"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": "In vertical (horizontal) violin plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one violin per distinct x (y) value is drawn If no `x` (`y`) {array} is provided, a single violin is drawn. That violin position is then positioned with `name` or with `x0` (`y0`) if provided."
},
- "type": "ohlc"
+ "type": "violin"
},
- "candlestick": {
+ "histogram": {
"animatable": false,
"attributes": {
- "type": "candlestick",
+ "type": "histogram",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='histogram'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='histogram'))"
},
"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).",
@@ -44122,35 +35700,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='histogram'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": true,
"editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='histogram'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -44158,7 +35736,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='histogram'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -44168,7 +35746,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='histogram'))"
},
"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.",
@@ -44183,7 +35761,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='histogram'))"
},
"role": "object",
"shadow": {
@@ -44191,13 +35769,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='histogram'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='histogram'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -44208,7 +35786,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='histogram'))"
},
"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.",
@@ -44221,7 +35799,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='histogram'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -44236,7 +35814,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='histogram'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -44249,9 +35827,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='histogram'))"
},
"role": "object",
"text": {
@@ -44259,16 +35837,16 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='histogram'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='histogram'))"
},
"opacity": {
"description": "Sets the opacity of the trace.",
@@ -44277,110 +35855,80 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='candlestick'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='histogram'))"
},
"x": {
- "description": "Sets the x coordinates. If absent, linear coordinate will be generated.",
+ "description": "Sets the sample data to be binned on the x axis.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='candlestick'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "close": {
- "description": "Sets the close values.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(close=<VALUE>, selector=dict(type='candlestick'))"
- },
- "closesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `close`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='histogram'))"
},
- "open": {
- "description": "Sets the open values.",
- "editType": "calc",
+ "y": {
+ "description": "Sets the sample data to be binned on the y axis.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(open=<VALUE>, selector=dict(type='candlestick'))"
- },
- "opensrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `open`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='histogram'))"
},
- "high": {
- "description": "Sets the high values.",
+ "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": "data_array",
- "magic_underscores": "fig.update_traces(high=<VALUE>, selector=dict(type='candlestick'))"
- },
- "highsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `high`.",
- "editType": "none",
- "valType": "string"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='histogram'))"
},
- "low": {
- "description": "Sets the low values.",
+ "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": "data_array",
- "magic_underscores": "fig.update_traces(low=<VALUE>, selector=dict(type='candlestick'))"
- },
- "lowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `low`.",
- "editType": "none",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "outside",
+ "auto",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='histogram'))"
},
- "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.",
+ "texttemplate": {
+ "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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": "calc",
+ "editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='histogram'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "texttemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "plot",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='histogram'))"
},
"hovertext": {
"arrayOk": true,
"description": "Same as `text`.",
"dflt": "",
- "editType": "calc",
+ "editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='candlestick'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='histogram'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -44396,1097 +35944,1190 @@
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='candlestick'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='histogram'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `open`, `high`, `low` and `close`. 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='histogram'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "none",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='candlestick'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='histogram'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='histogram'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='candlestick'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='candlestick'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='histogram'))"
},
- "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,
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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": "any",
- "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='candlestick'))"
+ "valType": "enumerated",
+ "values": [
+ "count",
+ "sum",
+ "avg",
+ "min",
+ "max"
+ ],
+ "magic_underscores": "fig.update_traces(histfunc=<VALUE>, selector=dict(type='histogram'))"
},
- "xperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
- "dflt": "middle",
+ "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": [
- "start",
- "middle",
- "end"
+ "",
+ "percent",
+ "probability",
+ "density",
+ "probability density"
],
- "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(histnorm=<VALUE>, selector=dict(type='histogram'))"
},
- "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.",
+ "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": "any",
- "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='candlestick'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='histogram'))"
},
- "line": {
- "editType": "style",
- "role": "object",
- "width": {
- "description": "Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='candlestick'))"
- },
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='candlestick'))"
+ "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",
+ "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='histogram'))"
},
- "whiskerwidth": {
- "description": "Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).",
+ "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",
- "max": 1,
"min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(whiskerwidth=<VALUE>, selector=dict(type='candlestick'))"
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(nbinsx=<VALUE>, selector=dict(type='histogram'))"
},
- "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.",
+ "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",
- "valType": "any",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='candlestick'))"
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(nbinsy=<VALUE>, selector=dict(type='histogram'))"
},
- "increasing": {
- "editType": "style",
- "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",
- "magic_underscores": "fig.update_traces(increasing_fillcolor=<VALUE>, selector=dict(type='candlestick'))"
+ "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",
+ "magic_underscores": "fig.update_traces(autobinx=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(autobiny=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(bingroup=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_end=<VALUE>, selector=dict(type='histogram'))"
},
- "line": {
- "color": {
- "description": "Sets the color of line bounding the box(es).",
- "dflt": "#3D9970",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(increasing_line_color=<VALUE>, selector=dict(type='candlestick'))"
- },
- "editType": "style",
- "role": "object",
- "width": {
- "description": "Sets the width (in px) of line bounding the box(es).",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(increasing_line_width=<VALUE>, selector=dict(type='candlestick'))"
- },
- "magic_underscores": "fig.update_traces(increasing_line=dict(...), selector=dict(type='candlestick'))"
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_size=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_start=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(xbins=dict(...), selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_end=<VALUE>, selector=dict(type='histogram'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(increasing=dict(...), selector=dict(type='candlestick'))"
- },
- "decreasing": {
- "editType": "style",
- "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",
- "magic_underscores": "fig.update_traces(decreasing_fillcolor=<VALUE>, selector=dict(type='candlestick'))"
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_size=<VALUE>, selector=dict(type='histogram'))"
},
- "line": {
- "color": {
- "description": "Sets the color of line bounding the box(es).",
- "dflt": "#FF4136",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(decreasing_line_color=<VALUE>, selector=dict(type='candlestick'))"
- },
- "editType": "style",
- "role": "object",
- "width": {
- "description": "Sets the width (in px) of line bounding the box(es).",
- "dflt": 2,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(decreasing_line_width=<VALUE>, selector=dict(type='candlestick'))"
- },
- "magic_underscores": "fig.update_traces(decreasing_line=dict(...), selector=dict(type='candlestick'))"
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_start=<VALUE>, selector=dict(type='histogram'))"
},
- "role": "object",
- "magic_underscores": "fig.update_traces(decreasing=dict(...), selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(ybins=dict(...), selector=dict(type='histogram'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='candlestick'))"
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='histogram'))"
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='histogram'))"
},
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='candlestick'))"
+ "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,
+ "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='histogram'))"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "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,
+ "editType": "calc",
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='histogram'))"
},
- "bordercolor": {
+ "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,
+ "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='histogram'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='histogram'))"
},
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='histogram'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='histogram'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='candlestick'))"
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='histogram'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='histogram'))"
},
- "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"
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
],
- "flags": [
- "under",
- "over",
- "through"
+ "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='histogram'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='candlestick'))"
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='histogram'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='histogram'))"
},
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='histogram'))"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "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",
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='histogram'))"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
+ "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": [
- "normal",
- "italic"
+ "allow",
+ "hide past div",
+ "hide past domain"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='candlestick'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='histogram'))"
},
- "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",
+ "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": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='histogram'))"
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='histogram'))"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "none",
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "auto",
+ "linear",
+ "array"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='histogram'))"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='histogram'))"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "none",
- "extras": [
- "normal",
- "bold"
+ "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",
+ ""
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='candlestick'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='histogram'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='candlestick'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='candlestick'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='candlestick'))"
- },
- "split": {
- "description": "Show hover information (open, close, high, low) in separate labels, rather than a single unified label. Default: *false*. When set to *true*, `hovertemplate` is ignored.",
- "dflt": false,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_split=<VALUE>, selector=dict(type='candlestick'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='candlestick'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='candlestick'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='candlestick'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='candlestick'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='candlestick'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='candlestick'))"
- },
- "magic_underscores": "fig.update_traces(..., selector=dict(type='candlestick'))"
- },
- "categories": [
- "cartesian",
- "svg",
- "showLegend",
- "candlestick",
- "boxLayout"
- ],
- "layoutAttributes": {
- "boxgap": {
- "description": "Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have *width* set.",
- "dflt": 0.3,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "boxgroupgap": {
- "description": "Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have *width* set.",
- "dflt": 0.3,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- },
- "boxmode": {
- "description": "Determines how boxes at the same location coordinate are displayed on the graph. If *group*, the boxes are plotted next to one another centered around the shared location. If *overlay*, the boxes are plotted over one another, you might need to set *opacity* to see them multiple boxes. Has no effect on traces that have *width* set.",
- "dflt": "overlay",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "group",
- "overlay"
- ]
- }
- },
- "meta": {
- "description": "The candlestick is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The boxes represent the spread between the `open` and `close` values and the lines represent the spread between the `low` and `high` values Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red."
- },
- "type": "candlestick"
- },
- "waterfall": {
- "animatable": false,
- "attributes": {
- "type": "waterfall",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='waterfall'))"
- },
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='waterfall'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='waterfall'))"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='waterfall'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='histogram'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='waterfall'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='histogram'))"
},
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='waterfall'))"
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='histogram'))"
},
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='waterfall'))"
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='histogram'))"
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='histogram'))"
},
- "size": {
- "editType": "style",
- "min": 1,
+ "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='histogram'))"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
- "italic"
+ "container",
+ "paper"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='histogram'))"
},
- "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",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
- "word caps",
- "upper",
- "lower"
+ "top",
+ "middle",
+ "bottom"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='histogram'))"
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "container",
+ "paper"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='histogram'))"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='histogram'))"
+ },
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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,
+ "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='waterfall'))"
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='histogram'))"
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='waterfall'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_cornerradius=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='waterfall'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='waterfall'))"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='waterfall'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
- "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='waterfall'))"
- },
- "x": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='waterfall'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='waterfall'))"
- },
- "dx": {
- "description": "Sets the x coordinate step. See `x0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(dx=<VALUE>, selector=dict(type='waterfall'))"
- },
- "y": {
- "description": "Sets the y coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='waterfall'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='waterfall'))"
- },
- "dy": {
- "description": "Sets the y coordinate step. See `y0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(dy=<VALUE>, selector=dict(type='waterfall'))"
- },
- "base": {
- "arrayOk": false,
- "description": "Sets where the bar base is drawn (in position axis units).",
- "dflt": null,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(base=<VALUE>, selector=dict(type='waterfall'))"
- },
- "width": {
- "arrayOk": true,
- "description": "Sets the bar width (in position axis units).",
- "dflt": null,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='waterfall'))"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
- "measure": {
- "description": "An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.",
- "dflt": [],
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(measure=<VALUE>, selector=dict(type='waterfall'))"
- },
- "measuresrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `measure`.",
- "editType": "none",
- "valType": "string"
- },
- "offset": {
- "arrayOk": true,
- "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",
- "magic_underscores": "fig.update_traces(offset=<VALUE>, selector=dict(type='waterfall'))"
- },
- "offsetsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `offset`.",
- "editType": "none",
- "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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='waterfall'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='waterfall'))"
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `initial`, `delta`, `final` and `label`.",
- "dflt": "",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='waterfall'))"
- },
- "texttemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "plot",
- "valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='waterfall'))"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='waterfall'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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": [
- "name",
- "x",
- "y",
- "text",
- "initial",
- "delta",
- "final"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='waterfall'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `initial`, `delta` and `final`. 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='waterfall'))"
- },
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "none",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='waterfall'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='waterfall'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='waterfall'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yperiod=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(yperiodalignment=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yperiod0=<VALUE>, selector=dict(type='waterfall'))"
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_line_autocolorscale=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_cauto_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_line_cauto=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_line_cmax_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmax=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_cmid_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmid=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_line_cmin_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmin=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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,
+ "magic_underscores": "fig.update_traces(marker_line_colorscale_impliedEdits=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_reversescale=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='histogram'))"
+ },
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the opacity of the bars.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_pattern_fgopacity=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_pattern_fillmode=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "path": {
+ "arrayOk": true,
+ "description": "Sets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "-",
+ "|",
+ "+",
+ "."
+ ],
+ "magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(textangle=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(textangle=<VALUE>, selector=dict(type='histogram'))"
},
"textfont": {
"color": {
- "arrayOk": true,
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='waterfall'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='histogram'))"
},
- "description": "Sets the font used for `text`.",
- "editType": "calc",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='waterfall'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"extras": [
"none"
],
@@ -45496,61 +37137,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='waterfall'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='waterfall'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='histogram'))"
},
"size": {
- "arrayOk": true,
- "editType": "calc",
+ "editType": "plot",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='waterfall'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='waterfall'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -45558,18 +37175,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='waterfall'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='histogram'))"
},
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -45579,18 +37190,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='waterfall'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='histogram'))"
},
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -45598,191 +37203,329 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='waterfall'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='waterfall'))"
- },
- "textinfo": {
- "arrayOk": false,
- "description": "Determines which trace information appear on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace).",
- "editType": "plot",
- "extras": [
- "none"
- ],
- "flags": [
- "label",
- "text",
- "initial",
- "delta",
- "final"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(textinfo=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cliponaxis=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='histogram'))"
},
- "connector": {
- "editType": "plot",
- "line": {
- "color": {
- "description": "Sets the line color.",
- "dflt": "#444",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(connector_line_color=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(connector_line_dash=<VALUE>, selector=dict(type='waterfall'))"
- },
- "editType": "plot",
- "role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
- "editType": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(connector_line_width=<VALUE>, selector=dict(type='waterfall'))"
- },
- "magic_underscores": "fig.update_traces(connector_line=dict(...), selector=dict(type='waterfall'))"
+ "error_x": {
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_array=<VALUE>, selector=dict(type='histogram'))"
},
- "mode": {
- "description": "Sets the shape of connector lines.",
- "dflt": "between",
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_arrayminus=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "color": {
+ "description": "Sets the stroke color of the error bars.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(error_x_color=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "copy_ystyle": {
"editType": "plot",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(error_x_copy_ystyle=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_symmetric=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(error_x_thickness=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "traceref": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_x_traceref=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_x_tracerefminus=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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": [
- "spanning",
- "between"
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
],
- "magic_underscores": "fig.update_traces(connector_mode=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(error_x_type=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_value=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_valueminus=<VALUE>, selector=dict(type='histogram'))"
},
- "role": "object",
"visible": {
- "description": "Determines if connector lines are drawn. ",
- "dflt": true,
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(error_x_visible=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
"editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(error_x_width=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(error_x=dict(...), selector=dict(type='histogram'))"
+ },
+ "error_y": {
+ "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",
+ "magic_underscores": "fig.update_traces(error_y_array=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_y_arrayminus=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "color": {
+ "description": "Sets the stroke color of the error bars.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(error_y_color=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(connector_visible=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(error_y_symmetric=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(connector=dict(...), selector=dict(type='waterfall'))"
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(error_y_thickness=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "traceref": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_y_traceref=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_y_tracerefminus=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(error_y_type=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_y_value=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_y_valueminus=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(error_y_visible=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(error_y_width=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(error_y=dict(...), selector=dict(type='histogram'))"
},
- "constraintext": {
- "description": "Constrain the size of text inside or outside a bar to be no larger than the bar itself.",
- "dflt": "both",
+ "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": "enumerated",
- "values": [
- "inside",
- "outside",
- "both",
- "none"
- ],
- "magic_underscores": "fig.update_traces(constraintext=<VALUE>, selector=dict(type='waterfall'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='histogram'))"
},
- "increasing": {
+ "selected": {
"editType": "style",
"marker": {
"color": {
- "arrayOk": false,
- "description": "Sets the marker color of all increasing values.",
+ "description": "Sets the marker color of selected points.",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(increasing_marker_color=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='histogram'))"
},
"editType": "style",
- "line": {
- "color": {
- "arrayOk": false,
- "description": "Sets the line color of all increasing values.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(increasing_marker_line_color=<VALUE>, selector=dict(type='waterfall'))"
- },
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
"editType": "style",
- "role": "object",
- "width": {
- "arrayOk": false,
- "description": "Sets the line width of all increasing values.",
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(increasing_marker_line_width=<VALUE>, selector=dict(type='waterfall'))"
- },
- "magic_underscores": "fig.update_traces(increasing_marker_line=dict(...), selector=dict(type='waterfall'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='histogram'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(increasing_marker=dict(...), selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='histogram'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(increasing=dict(...), selector=dict(type='waterfall'))"
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of selected points.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(selected_textfont_color=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "editType": "style",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(selected_textfont=dict(...), selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='histogram'))"
},
- "decreasing": {
+ "unselected": {
"editType": "style",
"marker": {
"color": {
- "arrayOk": false,
- "description": "Sets the marker color of all decreasing values.",
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(decreasing_marker_color=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='histogram'))"
},
"editType": "style",
- "line": {
- "color": {
- "arrayOk": false,
- "description": "Sets the line color of all decreasing values.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(decreasing_marker_line_color=<VALUE>, selector=dict(type='waterfall'))"
- },
+ "opacity": {
+ "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
"editType": "style",
- "role": "object",
- "width": {
- "arrayOk": false,
- "description": "Sets the line width of all decreasing values.",
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(decreasing_marker_line_width=<VALUE>, selector=dict(type='waterfall'))"
- },
- "magic_underscores": "fig.update_traces(decreasing_marker_line=dict(...), selector=dict(type='waterfall'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='histogram'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(decreasing_marker=dict(...), selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='histogram'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(decreasing=dict(...), selector=dict(type='waterfall'))"
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of unselected points, applied only when a selection exists.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(unselected_textfont_color=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "editType": "style",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(unselected_textfont=dict(...), selector=dict(type='histogram'))"
+ },
+ "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(cliponaxis=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(constraintext=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(cumulative_currentbin=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(cumulative_direction=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(cumulative_enabled=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(cumulative=dict(...), selector=dict(type='histogram'))"
},
"hoverlabel": {
"align": {
@@ -45796,36 +37539,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='waterfall'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='histogram'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='waterfall'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='histogram'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='waterfall'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='histogram'))"
},
"editType": "none",
"font": {
@@ -45833,12 +37561,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='waterfall'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='histogram'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -45849,12 +37572,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='waterfall'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='histogram'))"
},
"lineposition": {
"arrayOk": true,
@@ -45870,12 +37588,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='waterfall'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='histogram'))"
},
"role": "object",
"shadow": {
@@ -45884,24 +37597,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='waterfall'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='histogram'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='waterfall'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='histogram'))"
},
"style": {
"arrayOk": true,
@@ -45913,12 +37616,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='waterfall'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='histogram'))"
},
"textcase": {
"arrayOk": true,
@@ -45932,12 +37630,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='waterfall'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='histogram'))"
},
"variant": {
"arrayOk": true,
@@ -45953,12 +37646,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='waterfall'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='histogram'))"
},
"weight": {
"arrayOk": true,
@@ -45972,14 +37660,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='waterfall'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='histogram'))"
},
"namelength": {
"arrayOk": true,
@@ -45988,12 +37671,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='waterfall'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='histogram'))"
},
"role": "object",
"showarrow": {
@@ -46001,9 +37679,9 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='histogram'))"
},
"insidetextanchor": {
"description": "Determines if texts are kept at center or start/end points in `textposition` *inside* mode.",
@@ -46015,41 +37693,28 @@
"middle",
"start"
],
- "magic_underscores": "fig.update_traces(insidetextanchor=<VALUE>, selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(insidetextanchor=<VALUE>, selector=dict(type='histogram'))"
},
"insidetextfont": {
"color": {
- "arrayOk": true,
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='waterfall'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='histogram'))"
},
"description": "Sets the font used for `text` lying inside the bar.",
- "editType": "calc",
+ "editType": "plot",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='waterfall'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"extras": [
"none"
],
@@ -46059,61 +37724,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='waterfall'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='waterfall'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='histogram'))"
},
"size": {
- "arrayOk": true,
- "editType": "calc",
+ "editType": "plot",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='waterfall'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='waterfall'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -46121,18 +37762,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='waterfall'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='histogram'))"
},
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -46142,18 +37777,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='waterfall'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='histogram'))"
},
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -46161,48 +37790,30 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='waterfall'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='histogram'))"
},
"outsidetextfont": {
"color": {
- "arrayOk": true,
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='waterfall'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='histogram'))"
},
"description": "Sets the font used for `text` lying outside the bar.",
- "editType": "calc",
+ "editType": "plot",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='waterfall'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"extras": [
"none"
],
@@ -46212,61 +37823,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='waterfall'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='waterfall'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='histogram'))"
},
"size": {
- "arrayOk": true,
- "editType": "calc",
+ "editType": "plot",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='waterfall'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='waterfall'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='histogram'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -46274,18 +37861,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='waterfall'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='histogram'))"
},
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -46295,18 +37876,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='waterfall'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='histogram'))"
},
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -46314,100 +37889,92 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='waterfall'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='histogram'))"
},
- "totals": {
- "editType": "style",
- "marker": {
- "color": {
- "arrayOk": false,
- "description": "Sets the marker color of all intermediate sums and total values.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(totals_marker_color=<VALUE>, selector=dict(type='waterfall'))"
- },
- "editType": "style",
- "line": {
- "color": {
- "arrayOk": false,
- "description": "Sets the line color of all intermediate sums and total values.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(totals_marker_line_color=<VALUE>, selector=dict(type='waterfall'))"
- },
- "editType": "style",
- "role": "object",
- "width": {
- "arrayOk": false,
- "description": "Sets the line width of all intermediate sums and total values.",
- "dflt": 0,
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(totals_marker_line_width=<VALUE>, selector=dict(type='waterfall'))"
- },
- "magic_underscores": "fig.update_traces(totals_marker_line=dict(...), selector=dict(type='waterfall'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(totals_marker=dict(...), selector=dict(type='waterfall'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(totals=dict(...), selector=dict(type='waterfall'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='histogram'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='histogram'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='waterfall'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='waterfall'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='histogram'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='waterfall'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='histogram'))"
},
"categories": [
"bar-like",
"cartesian",
"svg",
+ "bar",
+ "histogram",
"oriented",
- "showLegend",
- "zoomScale"
+ "errorBarsOK",
+ "showLegend"
],
"layoutAttributes": {
- "waterfallgap": {
+ "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",
+ "valType": "any"
+ },
+ "bargap": {
"description": "Sets the gap (in plot fraction) between bars of adjacent location coordinates.",
"editType": "calc",
"max": 1,
"min": 0,
"valType": "number"
},
- "waterfallgroupgap": {
+ "bargroupgap": {
"description": "Sets the gap (in plot fraction) between bars of the same location coordinate.",
"dflt": 0,
"editType": "calc",
@@ -46415,37 +37982,50 @@
"min": 0,
"valType": "number"
},
- "waterfallmode": {
- "description": "Determines how bars at the same location coordinate are displayed on the graph. 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.",
+ "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"
+ "overlay",
+ "relative"
+ ]
+ },
+ "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"
]
}
},
"meta": {
- "description": "Draws waterfall trace which is useful graph to displays the contribution of various elements (either positive or negative) in a bar chart. The data visualized by the span of the bars is set in `y` if `orientation` is set to *v* (the default) and the labels are set in `x`. By setting `orientation` to *h*, the roles are interchanged."
+ "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": "waterfall"
+ "type": "histogram"
},
- "funnel": {
+ "histogram2d": {
"animatable": false,
"attributes": {
- "type": "funnel",
+ "type": "histogram2d",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='histogram2d'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='histogram2d'))"
},
"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).",
@@ -46457,35 +38037,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='histogram2d'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -46493,7 +38073,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='histogram2d'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -46503,7 +38083,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='histogram2d'))"
},
"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.",
@@ -46518,7 +38098,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
},
"role": "object",
"shadow": {
@@ -46526,13 +38106,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='histogram2d'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='histogram2d'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -46543,7 +38123,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='histogram2d'))"
},
"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.",
@@ -46556,7 +38136,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='histogram2d'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -46571,7 +38151,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='histogram2d'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -46584,9 +38164,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='histogram2d'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='histogram2d'))"
},
"role": "object",
"text": {
@@ -46594,16 +38174,16 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='histogram2d'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='histogram2d'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='histogram2d'))"
},
"opacity": {
"description": "Sets the opacity of the trace.",
@@ -46612,161 +38192,65 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='funnel'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
- "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='histogram2d'))"
},
"x": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='funnel'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "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,
+ "description": "Sets the sample data to be binned on the x axis.",
"editType": "calc+clearAxisTypes",
- "valType": "any",
- "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='histogram2d'))"
},
- "dx": {
- "description": "Sets the x coordinate step. See `x0` for more info.",
- "dflt": 1,
- "editType": "calc",
+ "xgap": {
+ "description": "Sets the horizontal gap (in pixels) between bricks.",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(dx=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(xgap=<VALUE>, selector=dict(type='histogram2d'))"
},
"y": {
- "description": "Sets the y coordinates.",
+ "description": "Sets the sample data to be binned on the y axis.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='funnel'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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.",
+ "ygap": {
+ "description": "Sets the vertical gap (in pixels) between bricks.",
"dflt": 0,
- "editType": "calc+clearAxisTypes",
- "valType": "any",
- "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='funnel'))"
- },
- "dy": {
- "description": "Sets the y coordinate step. See `y0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(dy=<VALUE>, selector=dict(type='funnel'))"
- },
- "width": {
- "arrayOk": false,
- "description": "Sets the bar width (in position axis units).",
- "dflt": null,
- "editType": "calc",
+ "editType": "plot",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(offset=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='funnel'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ygap=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
+ "z": {
+ "description": "Sets the aggregation data.",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "inside",
- "outside",
- "auto",
- "none"
- ],
- "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='funnel'))"
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='histogram2d'))"
},
"texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`.",
+ "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='histogram2d'))"
},
"texttemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "plot",
"valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='funnel'))"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='funnel'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='histogram2d'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -46775,457 +38259,799 @@
"skip"
],
"flags": [
- "name",
"x",
"y",
+ "z",
"text",
- "percent initial",
- "percent previous",
- "percent total"
+ "name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='funnel'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='histogram2d'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='histogram2d'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "none",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='funnel'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='histogram2d'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='histogram2d'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='funnel'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='funnel'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
+ "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",
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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": [
- "v",
- "h"
+ "count",
+ "sum",
+ "avg",
+ "min",
+ "max"
],
- "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(histfunc=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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.",
+ "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": "string",
- "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "enumerated",
+ "values": [
+ "",
+ "percent",
+ "probability",
+ "density",
+ "probability density"
+ ],
+ "magic_underscores": "fig.update_traces(histnorm=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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": "",
+ "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",
- "valType": "string",
- "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='funnel'))"
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(nbinsx=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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.",
+ "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",
- "valType": "any",
- "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='funnel'))"
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(nbinsy=<VALUE>, selector=dict(type='histogram2d'))"
},
- "xperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.",
- "dflt": "middle",
+ "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": [
- "start",
- "middle",
- "end"
- ],
- "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(autobinx=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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.",
+ "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": "any",
- "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(autobiny=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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,
+ "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": "any",
- "magic_underscores": "fig.update_traces(yperiod=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(bingroup=<VALUE>, selector=dict(type='histogram2d'))"
},
- "yperiodalignment": {
- "description": "Only relevant when the axis `type` is *date*. Sets the alignment of data points on the y axis.",
- "dflt": "middle",
+ "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": "enumerated",
- "values": [
- "start",
- "middle",
- "end"
- ],
- "magic_underscores": "fig.update_traces(yperiodalignment=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(xbingroup=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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.",
+ "xbins": {
"editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(yperiod0=<VALUE>, selector=dict(type='funnel'))"
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_end=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_size=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_start=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "magic_underscores": "fig.update_traces(xbins=dict(...), selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ybingroup=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_end=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_size=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_start=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "magic_underscores": "fig.update_traces(ybins=dict(...), selector=dict(type='histogram2d'))"
},
"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,
+ "color": {
+ "description": "Sets the aggregation data.",
"editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "editType": "calc",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='histogram2d'))"
+ },
+ "textfont": {
+ "color": {
+ "dflt": "auto",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "size": {
+ "dflt": "auto",
+ "editType": "plot",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='histogram2d'))"
+ },
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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": {
- "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ "tickmode": "linear",
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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.",
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "calc",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
+ "editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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,
- "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='funnel'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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": {
- "cauto": false,
- "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ "tickmode": "linear",
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='funnel'))"
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='funnel'))"
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='histogram2d'))"
},
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='funnel'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
+ "tickfont": {
+ "color": {
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='funnel'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='histogram2d'))"
},
+ "description": "Sets the color bar's tick label font",
"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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='funnel'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='funnel'))"
- },
- "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,
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
"editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='funnel'))"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
+ "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",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
+ "extras": [
+ "none"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='funnel'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
+ "flags": [
+ "under",
+ "over",
+ "through"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
+ "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": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='histogram2d'))"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
+ "size": {
"editType": "colorbars",
- "min": 0,
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='funnel'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
+ "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": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='funnel'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
+ "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": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='histogram2d'))"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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": "colorbars",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
+ "extras": [
+ "normal",
+ "bold"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='funnel'))"
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ }
+ }
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='funnel'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
- "tickfont": {
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ ""
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
"color": {
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='histogram2d'))"
},
- "description": "Sets the color bar's tick label font",
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
@@ -47233,7 +39059,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='histogram2d'))"
},
"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.",
@@ -47248,7 +39074,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
},
"role": "object",
"shadow": {
@@ -47256,13 +39082,13 @@
"dflt": "none",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='histogram2d'))"
},
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='histogram2d'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -47273,7 +39099,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='histogram2d'))"
},
"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.",
@@ -47281,1089 +39107,965 @@
"editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='funnel'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='funnel'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='funnel'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='funnel'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='funnel'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- ""
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='funnel'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='funnel'))"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='funnel'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='funnel'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='funnel'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='funnel'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='funnel'))"
- },
- "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*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='funnel'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='funnel'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='funnel'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='funnel'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='funnel'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='funnel'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='funnel'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_line_autocolorscale=<VALUE>, selector=dict(type='funnel'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_cauto_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_line_cauto=<VALUE>, selector=dict(type='funnel'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_cmax_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmax=<VALUE>, selector=dict(type='funnel'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_cmid_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='histogram2d'))"
},
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmid=<VALUE>, selector=dict(type='funnel'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_cmin_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='histogram2d'))"
},
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmin=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='funnel'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_colorscale_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='histogram2d'))"
},
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_reversescale=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='histogram2d'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='funnel'))"
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='histogram2d'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='histogram2d'))"
},
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='histogram2d'))"
},
- "opacity": {
- "arrayOk": true,
- "description": "Sets the opacity of the bars.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='histogram2d'))"
},
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "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",
+ "valType": "enumerated",
+ "values": [
+ "container",
+ "paper"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='funnel'))"
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='funnel'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='histogram2d'))"
},
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(textangle=<VALUE>, selector=dict(type='funnel'))"
- },
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='funnel'))"
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='histogram2d'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='histogram2d'))"
},
- "description": "Sets the font used for `text`.",
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='histogram2d'))"
+ },
+ "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",
- "family": {
- "arrayOk": true,
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='funnel'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='funnel'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='histogram2d'))"
},
- "size": {
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "zsmooth": {
+ "description": "Picks a smoothing algorithm use to smooth `z` data.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "fast",
+ "best",
+ false
+ ],
+ "magic_underscores": "fig.update_traces(zsmooth=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "hoverlabel": {
+ "align": {
"arrayOk": true,
- "editType": "calc",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='funnel'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+ "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"
- },
- "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"
+ "left",
+ "right",
+ "auto"
],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='funnel'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='histogram2d'))"
},
- "textcase": {
+ "bgcolor": {
"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"
- ],
- "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='funnel'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
+ "description": "Sets the background color of the hover labels for this trace",
"editType": "none",
- "valType": "string"
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='histogram2d'))"
},
- "variant": {
+ "bordercolor": {
"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"
- ],
- "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='funnel'))"
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='histogram2d'))"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "description": "Sets the font used in hover labels.",
"editType": "none",
- "valType": "string"
+ "family": {
+ "arrayOk": true,
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='histogram2d'))"
},
- "weight": {
+ "namelength": {
"arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
+ "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",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='histogram2d'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
+ "role": "object",
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
"editType": "none",
- "valType": "string"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='histogram2d'))"
},
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='histogram2d'))"
},
- "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"
+ "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"
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(textinfo=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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.",
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='histogram2d'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='histogram2d'))"
},
- "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,
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='histogram2d'))"
+ },
+ "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": {
+ "type": "histogram2dcontour",
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(cliponaxis=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "connector": {
- "editType": "plot",
- "fillcolor": {
- "description": "Sets the fill color.",
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(connector_fillcolor=<VALUE>, selector=dict(type='funnel'))"
- },
- "line": {
+ "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",
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
"color": {
- "description": "Sets the line color.",
- "dflt": "#444",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(connector_line_color=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
"editType": "style",
+ "noBlank": true,
+ "strict": true,
"valType": "string",
- "values": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
],
- "magic_underscores": "fig.update_traces(connector_line_dash=<VALUE>, selector=dict(type='funnel'))"
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "editType": "style",
"role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 0,
- "editType": "plot",
- "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(connector_line_width=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(connector_line=dict(...), selector=dict(type='funnel'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='histogram2dcontour'))"
},
"role": "object",
- "visible": {
- "description": "Determines if connector regions and lines are drawn.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(connector_visible=<VALUE>, selector=dict(type='funnel'))"
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(connector=dict(...), selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='histogram2dcontour'))"
},
- "constraintext": {
- "description": "Constrain the size of text inside or outside a bar to be no larger than the bar itself.",
- "dflt": "both",
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "x": {
+ "description": "Sets the sample data to be binned on the x axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "y": {
+ "description": "Sets the sample data to be binned on the y axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "z": {
+ "description": "Sets the aggregation data.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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 appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "texttemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "plot",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines what trace information appears on hover. 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",
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "hovertemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "none",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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": [
- "inside",
- "outside",
- "both",
- "none"
+ "count",
+ "sum",
+ "avg",
+ "min",
+ "max"
],
- "magic_underscores": "fig.update_traces(constraintext=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(histfunc=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='funnel'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(histnorm=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(nbinsx=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(nbinsy=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(autobinx=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(autobiny=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(bingroup=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xbingroup=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_end=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='funnel'))"
+ "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",
+ "magic_underscores": "fig.update_traces(xbins_start=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(xbins=dict(...), selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ybingroup=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_end=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='funnel'))"
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(ybins_start=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "editType": "none",
- "font": {
- "color": {
- "arrayOk": true,
- "editType": "none",
- "valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='funnel'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='funnel'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(ybins=dict(...), selector=dict(type='histogram2dcontour'))"
+ },
+ "marker": {
+ "color": {
+ "description": "Sets the aggregation data.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='funnel'))"
+ "editType": "calc",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "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",
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ],
+ "magic_underscores": "fig.update_traces(line_dash=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
+ "editType": "plot",
"role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='funnel'))"
+ "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",
+ "magic_underscores": "fig.update_traces(line_smoothing=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='funnel'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(insidetextanchor=<VALUE>, selector=dict(type='funnel'))"
+ "width": {
+ "description": "Sets the contour line width in (in px)",
+ "dflt": 0.5,
+ "editType": "style+colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='histogram2dcontour'))"
},
- "insidetextfont": {
+ "textfont": {
"color": {
- "arrayOk": true,
+ "dflt": "auto",
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='funnel'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "description": "Sets the font used for `text` lying inside the bar.",
- "editType": "calc",
+ "description": "For this trace it only has an effect if `coloring` is set to *heatmap*. 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='funnel'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"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": "plot",
"extras": [
"none"
],
@@ -48373,61 +40075,38 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='funnel'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"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": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='funnel'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"size": {
- "arrayOk": true,
- "editType": "calc",
+ "dflt": "auto",
+ "editType": "plot",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='funnel'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='funnel'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -48435,18 +40114,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='funnel'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -48456,18 +40129,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='funnel'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -48475,290 +40142,245 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='funnel'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='histogram2dcontour'))"
},
- "outsidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "style",
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='funnel'))"
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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"
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
- "magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='funnel'))"
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "size": {
- "arrayOk": true,
- "editType": "calc",
- "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",
- "magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "italic"
+ "h",
+ "v"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
],
- "magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
+ "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"
],
- "magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='funnel'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
+ "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"
],
- "magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
+ "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"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='funnel'))"
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='funnel'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='funnel'))"
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='funnel'))"
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='funnel'))"
- },
- "magic_underscores": "fig.update_traces(..., selector=dict(type='funnel'))"
- },
- "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",
- "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."
- },
- "type": "funnel"
- },
- "funnelarea": {
- "animatable": false,
- "attributes": {
- "type": "funnelarea",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "title": {
- "editType": "plot",
- "font": {
+ "tickfont": {
"color": {
- "arrayOk": true,
- "editType": "plot",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(title_font_color=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "description": "Sets the font used for `title`.",
- "editType": "plot",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(title_font_family=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"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": "colorbars",
"extras": [
"none"
],
@@ -48768,896 +40390,741 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(title_font_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "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",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ ""
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='histogram2dcontour'))"
},
"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",
- "magic_underscores": "fig.update_traces(title_font_shadow=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(title_font_size=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(title_font_style=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(title_font_textcase=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ],
- "magic_underscores": "fig.update_traces(title_font_variant=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
+ "right",
+ "top",
+ "bottom"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(title_font_weight=<VALUE>, selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(title_font=dict(...), selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='histogram2dcontour'))"
},
- "position": {
- "description": "Specifies the location of the `title`.",
- "dflt": "top center",
- "editType": "plot",
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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": [
- "top left",
- "top center",
- "top right"
+ "left",
+ "center",
+ "right"
],
- "magic_underscores": "fig.update_traces(title_position=<VALUE>, selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "role": "object",
- "text": {
- "description": "Sets the title of the chart. If it is empty, no title is displayed.",
- "dflt": "",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(title_text=<VALUE>, selector=dict(type='funnelarea'))"
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(title=dict(...), selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='funnelarea'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='funnelarea'))"
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='funnelarea'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "values": {
- "description": "Sets the values of the sectors. If omitted, we count occurrences of each label.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(values=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(labels=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "labelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
- "editType": "none",
- "valType": "string"
- },
- "dlabel": {
- "description": "Sets the label step. See `label0` for more info.",
- "dflt": 1,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(dlabel=<VALUE>, selector=dict(type='funnelarea'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='histogram2dcontour'))"
},
- "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,
+ "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": "number",
- "magic_underscores": "fig.update_traces(label0=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "textposition": {
- "arrayOk": true,
- "description": "Specifies the location of the `textinfo`.",
- "dflt": "inside",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "inside",
- "none"
- ],
- "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "texttemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "plot",
- "valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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": [
- "label",
- "text",
- "value",
- "percent",
- "name"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='funnelarea'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "none",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='funnelarea'))"
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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.",
+ "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": "any",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
+ "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",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='funnelarea'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rule for `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": "string",
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
- "magic_underscores": "fig.update_traces(domain_column=<VALUE>, selector=dict(type='funnelarea'))"
+ "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,
+ "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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",
- "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",
- "magic_underscores": "fig.update_traces(domain_row=<VALUE>, selector=dict(type='funnelarea'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array",
- "magic_underscores": "fig.update_traces(domain_x=list(...), selector=dict(type='funnelarea'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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"
- },
- {
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number"
- }
- ],
- "valType": "info_array",
- "magic_underscores": "fig.update_traces(domain_y=list(...), selector=dict(type='funnelarea'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(autocontour_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(domain=dict(...), selector=dict(type='funnelarea'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(autocontour=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "marker": {
- "colors": {
- "description": "Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.",
+ "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": "data_array",
- "magic_underscores": "fig.update_traces(marker_colors=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "colorssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
- "editType": "none",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "fill",
+ "heatmap",
+ "lines",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(contours_coloring=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "end": {
+ "description": "Sets the end contour level value. Must be more than `contours.start`",
+ "dflt": null,
+ "editType": "plot",
+ "impliedEdits": {
+ "^autocontour": false,
+ "magic_underscores": "fig.update_traces(contours_end_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_end=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "impliedEdits": {
+ "autocontour": false,
"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",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(contours_impliedEdits=dict(...), selector=dict(type='histogram2dcontour'))"
},
- "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.",
+ "labelfont": {
+ "color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(contours_labelfont_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(contours_labelfont_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='funnelarea'))"
+ "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",
+ "magic_underscores": "fig.update_traces(contours_labelfont_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "fgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
- "editType": "none",
- "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": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(contours_labelfont_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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,
+ "size": {
+ "editType": "plot",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_pattern_fgopacity=<VALUE>, selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(contours_labelfont_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "fillmode": {
- "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
- "dflt": "replace",
- "editType": "style",
+ "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": [
- "replace",
- "overlay"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(marker_pattern_fillmode=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "path": {
- "arrayOk": true,
- "description": "Sets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(contours_labelfont_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
+ "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": [
- "",
- "/",
- "\\",
- "x",
- "-",
- "|",
- "+",
- "."
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
],
- "magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(contours_labelfont_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='funnelarea'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(contours_labelfont_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(contours_labelfont_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='funnelarea'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='funnelarea'))"
- },
- "textfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(contours_labelfont=dict(...), selector=dict(type='histogram2dcontour'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "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",
- "noBlank": true,
- "strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(contours_labelformat=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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"
+ "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.",
+ "dflt": "=",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "=",
+ "<",
+ ">=",
+ ">",
+ "<=",
+ "[]",
+ "()",
+ "[)",
+ "(]",
+ "][",
+ ")(",
+ "](",
+ ")["
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(contours_operation=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"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",
+ "showlabels": {
+ "description": "Determines whether to label the contour lines with their values.",
+ "dflt": false,
"editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='funnelarea'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_showlabels=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(contours_showlines=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"size": {
- "arrayOk": true,
+ "description": "Sets the step between each contour level. Must be positive.",
+ "dflt": null,
"editType": "plot",
- "min": 1,
+ "impliedEdits": {
+ "^autocontour": false,
+ "magic_underscores": "fig.update_traces(contours_size_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(contours_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
+ "start": {
+ "description": "Sets the starting contour level value. Must be less than `contours.end`",
+ "dflt": null,
"editType": "plot",
- "extras": [
- "normal",
- "bold"
+ "impliedEdits": {
+ "^autocontour": false,
+ "magic_underscores": "fig.update_traces(contours_start_impliedEdits=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_start=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(contours_type=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(contours_value=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='funnelarea'))"
- },
- "textinfo": {
- "description": "Determines which trace information appear on the graph.",
- "editType": "calc",
- "extras": [
- "none"
- ],
- "flags": [
- "label",
- "text",
- "value",
- "percent"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(textinfo=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "aspectratio": {
- "description": "Sets the ratio between height and width",
- "dflt": 1,
- "editType": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(aspectratio=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "baseratio": {
- "description": "Sets the ratio between bottom length and maximum top length.",
- "dflt": 0.333,
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(baseratio=<VALUE>, selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(contours=dict(...), selector=dict(type='histogram2dcontour'))"
},
"hoverlabel": {
"align": {
@@ -49671,36 +41138,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"editType": "none",
"font": {
@@ -49708,12 +41160,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -49724,12 +41171,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"lineposition": {
"arrayOk": true,
@@ -49745,12 +41187,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"role": "object",
"shadow": {
@@ -49759,24 +41196,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"style": {
"arrayOk": true,
@@ -49788,12 +41215,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"textcase": {
"arrayOk": true,
@@ -49807,12 +41229,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"variant": {
"arrayOk": true,
@@ -49828,12 +41245,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"weight": {
"arrayOk": true,
@@ -49847,14 +41259,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='histogram2dcontour'))"
},
"namelength": {
"arrayOk": true,
@@ -49863,12 +41270,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"role": "object",
"showarrow": {
@@ -49876,370 +41278,105 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='histogram2dcontour'))"
},
- "insidetextfont": {
- "color": {
- "arrayOk": true,
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='funnelarea'))"
+ "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",
+ "magic_underscores": "fig.update_traces(ncontours=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "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": "",
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
"editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(scalegroup=<VALUE>, selector=dict(type='funnelarea'))"
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ],
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='histogram2dcontour'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='funnelarea'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='histogram2dcontour'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='funnelarea'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='histogram2dcontour'))"
},
"categories": [
- "pie-like",
- "funnelarea",
+ "cartesian",
+ "svg",
+ "2dMap",
+ "contour",
+ "histogram",
"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."
+ "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": "funnelarea"
+ "type": "histogram2dcontour"
},
- "indicator": {
- "animatable": true,
+ "ohlc": {
+ "animatable": false,
"attributes": {
- "type": "indicator",
+ "type": "ohlc",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='ohlc'))"
},
"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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(title_align=<VALUE>, selector=dict(type='indicator'))"
- },
- "editType": "plot",
- "font": {
- "color": {
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(title_font_color=<VALUE>, selector=dict(type='indicator'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(title_font_family=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(title_font_lineposition=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(title_font_shadow=<VALUE>, selector=dict(type='indicator'))"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(title_font_size=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(title_font_style=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(title_font_textcase=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(title_font_variant=<VALUE>, selector=dict(type='indicator'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(title_font_weight=<VALUE>, selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(title_font=dict(...), selector=dict(type='indicator'))"
- },
- "role": "object",
- "text": {
- "description": "Sets the title of this indicator.",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(title_text=<VALUE>, selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(title=dict(...), selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='ohlc'))"
},
"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).",
@@ -50251,21 +41388,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='ohlc'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='ohlc'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='ohlc'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -50273,7 +41424,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='ohlc'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -50283,7 +41434,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='ohlc'))"
},
"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.",
@@ -50298,7 +41449,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='ohlc'))"
},
"role": "object",
"shadow": {
@@ -50306,13 +41457,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='ohlc'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='ohlc'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -50323,7 +41474,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='ohlc'))"
},
"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.",
@@ -50336,7 +41487,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='ohlc'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -50351,7 +41502,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='ohlc'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -50364,9 +41515,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='ohlc'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='ohlc'))"
},
"role": "object",
"text": {
@@ -50374,361 +41525,352 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='ohlc'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='ohlc'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='ohlc'))"
},
- "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",
- "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='indicator'))"
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='ohlc'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='ohlc'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
+ "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='ohlc'))"
},
- "value": {
- "anim": true,
- "description": "Sets the number to be displayed.",
+ "x": {
+ "description": "Sets the x coordinates. If absent, linear coordinate will be generated.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "close": {
+ "description": "Sets the close values.",
"editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(value=<VALUE>, selector=dict(type='indicator'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(close=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "open": {
+ "description": "Sets the open values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(open=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "high": {
+ "description": "Sets the high values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(high=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "low": {
+ "description": "Sets the low values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(low=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Same as `text`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines what trace information appears on hover. 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",
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `open`, `high`, `low` and `close`. 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",
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "hovertemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "none",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='ohlc'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='indicator'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='ohlc'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='ohlc'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='ohlc'))"
},
- "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",
- "magic_underscores": "fig.update_traces(domain_column=<VALUE>, selector=dict(type='indicator'))"
- },
+ "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",
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "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",
- "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",
- "magic_underscores": "fig.update_traces(domain_row=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(domain_x=list(...), selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(domain_y=list(...), selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(domain=dict(...), selector=dict(type='indicator'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='ohlc'))"
},
- "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",
+ "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": [
- "left",
- "center",
- "right"
+ "start",
+ "middle",
+ "end"
],
- "magic_underscores": "fig.update_traces(align=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='ohlc'))"
},
- "delta": {
- "decreasing": {
- "color": {
- "description": "Sets the color for increasing value.",
- "dflt": "#FF4136",
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(delta_decreasing_color=<VALUE>, selector=dict(type='indicator'))"
- },
- "editType": "plot",
- "role": "object",
- "symbol": {
- "description": "Sets the symbol to display for increasing value",
- "dflt": "\u25bc",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(delta_decreasing_symbol=<VALUE>, selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(delta_decreasing=dict(...), selector=dict(type='indicator'))"
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_dash=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px). 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",
+ "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='ohlc'))"
},
+ "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='ohlc'))"
+ },
+ "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",
- "font": {
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "increasing": {
+ "editType": "style",
+ "line": {
"color": {
- "editType": "plot",
+ "description": "Sets the line color.",
+ "dflt": "#3D9970",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(delta_font_color=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(increasing_line_color=<VALUE>, selector=dict(type='ohlc'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
+ "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",
- "magic_underscores": "fig.update_traces(delta_font_family=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(delta_font_lineposition=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(increasing_line_dash=<VALUE>, selector=dict(type='ohlc'))"
},
+ "editType": "style",
"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",
- "magic_underscores": "fig.update_traces(delta_font_shadow=<VALUE>, selector=dict(type='indicator'))"
- },
- "size": {
- "editType": "plot",
- "min": 1,
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(delta_font_size=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(delta_font_style=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(delta_font_textcase=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(delta_font_variant=<VALUE>, selector=dict(type='indicator'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(delta_font_weight=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(increasing_line_width=<VALUE>, selector=dict(type='ohlc'))"
},
- "magic_underscores": "fig.update_traces(delta_font=dict(...), selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(increasing_line=dict(...), selector=dict(type='ohlc'))"
},
- "increasing": {
+ "role": "object",
+ "magic_underscores": "fig.update_traces(increasing=dict(...), selector=dict(type='ohlc'))"
+ },
+ "decreasing": {
+ "editType": "style",
+ "line": {
"color": {
- "description": "Sets the color for increasing value.",
- "dflt": "#3D9970",
- "editType": "plot",
+ "description": "Sets the line color.",
+ "dflt": "#FF4136",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(delta_increasing_color=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(decreasing_line_color=<VALUE>, selector=dict(type='ohlc'))"
},
- "editType": "plot",
- "role": "object",
- "symbol": {
- "description": "Sets the symbol to display for increasing value",
- "dflt": "\u25b2",
- "editType": "plot",
+ "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",
- "magic_underscores": "fig.update_traces(delta_increasing_symbol=<VALUE>, selector=dict(type='indicator'))"
+ "values": [
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
+ ],
+ "magic_underscores": "fig.update_traces(decreasing_line_dash=<VALUE>, selector=dict(type='ohlc'))"
},
- "magic_underscores": "fig.update_traces(delta_increasing=dict(...), selector=dict(type='indicator'))"
- },
- "position": {
- "description": "Sets the position of delta with respect to the number.",
- "dflt": "bottom",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "top",
- "bottom",
- "left",
- "right"
- ],
- "magic_underscores": "fig.update_traces(delta_position=<VALUE>, selector=dict(type='indicator'))"
- },
- "prefix": {
- "description": "Sets a prefix appearing before the delta.",
- "dflt": "",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(delta_prefix=<VALUE>, selector=dict(type='indicator'))"
- },
- "reference": {
- "description": "Sets the reference value to compute the delta. By default, it is set to the current value.",
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(delta_reference=<VALUE>, selector=dict(type='indicator'))"
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(decreasing_line_width=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "magic_underscores": "fig.update_traces(decreasing_line=dict(...), selector=dict(type='ohlc'))"
},
- "relative": {
- "description": "Show relative change",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(delta_relative=<VALUE>, selector=dict(type='indicator'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(decreasing=dict(...), selector=dict(type='ohlc'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='ohlc'))"
},
- "role": "object",
- "suffix": {
- "description": "Sets a suffix appearing next to the delta.",
- "dflt": "",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(delta_suffix=<VALUE>, selector=dict(type='indicator'))"
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='ohlc'))"
},
- "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",
- "magic_underscores": "fig.update_traces(delta_valueformat=<VALUE>, selector=dict(type='indicator'))"
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='ohlc'))"
},
- "magic_underscores": "fig.update_traces(delta=dict(...), selector=dict(type='indicator'))"
- },
- "number": {
- "editType": "plot",
+ "editType": "none",
"font": {
"color": {
- "editType": "plot",
+ "arrayOk": true,
+ "editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(number_font_color=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='ohlc'))"
},
- "description": "Set the font used to display main number",
- "editType": "plot",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
+ "editType": "none",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(number_font_family=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='ohlc'))"
},
"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": "none",
"extras": [
"none"
],
@@ -50738,37 +41880,41 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(number_font_lineposition=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='ohlc'))"
},
"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",
+ "editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(number_font_shadow=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='ohlc'))"
},
"size": {
- "editType": "plot",
+ "arrayOk": true,
+ "editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(number_font_size=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='ohlc'))"
},
"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": "none",
"valType": "enumerated",
"values": [
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(number_font_style=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='ohlc'))"
},
"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": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -50776,12 +41922,13 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(number_font_textcase=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='ohlc'))"
},
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -50791,12 +41938,13 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(number_font_variant=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='ohlc'))"
},
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "plot",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -50804,668 +41952,772 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(number_font_weight=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='ohlc'))"
},
- "magic_underscores": "fig.update_traces(number_font=dict(...), selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='ohlc'))"
},
- "prefix": {
- "description": "Sets a prefix appearing before the number.",
- "dflt": "",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(number_prefix=<VALUE>, selector=dict(type='indicator'))"
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='ohlc'))"
},
"role": "object",
- "suffix": {
- "description": "Sets a suffix appearing next to the number.",
- "dflt": "",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(number_suffix=<VALUE>, selector=dict(type='indicator'))"
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='ohlc'))"
},
- "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",
- "magic_underscores": "fig.update_traces(number_valueformat=<VALUE>, selector=dict(type='indicator'))"
+ "split": {
+ "description": "Show hover information (open, close, high, low) in separate labels, rather than a single unified label. Default: *false*. When set to *true*, `hovertemplate` is ignored.",
+ "dflt": false,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_split=<VALUE>, selector=dict(type='ohlc'))"
},
- "magic_underscores": "fig.update_traces(number=dict(...), selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='ohlc'))"
},
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_dtick_impliedEdits=<VALUE>, selector=dict(type='indicator'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(gauge_axis_dtick=<VALUE>, selector=dict(type='indicator'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(gauge_axis_exponentformat=<VALUE>, selector=dict(type='indicator'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(gauge_axis_labelalias=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_minexponent=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_nticks=<VALUE>, selector=dict(type='indicator'))"
- },
- "range": {
- "description": "Sets the range of this axis.",
- "editType": "plot",
- "items": [
- {
- "editType": "plot",
- "valType": "number"
- },
- {
- "editType": "plot",
- "valType": "number"
- }
- ],
- "valType": "info_array",
- "magic_underscores": "fig.update_traces(gauge_axis_range=list(...), selector=dict(type='indicator'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(gauge_axis_separatethousands=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(gauge_axis_showexponent=<VALUE>, selector=dict(type='indicator'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "plot",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(gauge_axis_showticklabels=<VALUE>, selector=dict(type='indicator'))"
+ "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",
+ "magic_underscores": "fig.update_traces(tickwidth=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='ohlc'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='ohlc'))"
+ },
+ "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) than the open value are called increasing (decreasing). By default, increasing items are drawn in green whereas decreasing are drawn in red."
+ },
+ "type": "ohlc"
+ },
+ "candlestick": {
+ "animatable": false,
+ "attributes": {
+ "type": "candlestick",
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='candlestick'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(gauge_axis_showtickprefix=<VALUE>, selector=dict(type='indicator'))"
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='candlestick'))"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
+ "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"
],
- "magic_underscores": "fig.update_traces(gauge_axis_showticksuffix=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_tick0_impliedEdits=<VALUE>, selector=dict(type='indicator'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(gauge_axis_tick0=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_tickangle=<VALUE>, selector=dict(type='indicator'))"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(gauge_axis_tickcolor=<VALUE>, selector=dict(type='indicator'))"
- },
- "tickfont": {
- "color": {
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_color=<VALUE>, selector=dict(type='indicator'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "plot",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_family=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_lineposition=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_shadow=<VALUE>, selector=dict(type='indicator'))"
- },
- "size": {
- "editType": "plot",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_size=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_style=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_textcase=<VALUE>, selector=dict(type='indicator'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_variant=<VALUE>, selector=dict(type='indicator'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "plot",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont_weight=<VALUE>, selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(gauge_axis_tickfont=dict(...), selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_tickformat=<VALUE>, selector=dict(type='indicator'))"
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='candlestick'))"
},
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_tickformatstops=list(...), selector=dict(type='indicator'))"
+ "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='candlestick'))"
},
- "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",
+ "size": {
+ "editType": "style",
"min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(gauge_axis_ticklabelstep=<VALUE>, selector=dict(type='indicator'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "plot",
- "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(gauge_axis_ticklen=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='candlestick'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(gauge_axis_tickmode_impliedEdits=<VALUE>, selector=dict(type='indicator'))"
- },
+ "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"
],
- "magic_underscores": "fig.update_traces(gauge_axis_tickmode=<VALUE>, selector=dict(type='indicator'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(gauge_axis_tickprefix=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='candlestick'))"
},
- "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",
+ "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"
],
- "magic_underscores": "fig.update_traces(gauge_axis_ticks=<VALUE>, selector=dict(type='indicator'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(gauge_axis_ticksuffix=<VALUE>, selector=dict(type='indicator'))"
- },
- "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": "plot",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(gauge_axis_ticktext=<VALUE>, selector=dict(type='indicator'))"
- },
- "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": "plot",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(gauge_axis_tickvals=<VALUE>, selector=dict(type='indicator'))"
- },
- "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": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(gauge_axis_tickwidth=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_axis_visible=<VALUE>, selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(gauge_axis=dict(...), selector=dict(type='indicator'))"
- },
- "bar": {
- "color": {
- "description": "Sets the background color of the arc.",
- "dflt": "green",
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(gauge_bar_color=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='candlestick'))"
},
- "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",
- "magic_underscores": "fig.update_traces(gauge_bar_line_color=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(gauge_bar_line_width=<VALUE>, selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(gauge_bar_line=dict(...), selector=dict(type='indicator'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='candlestick'))"
},
- "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",
- "magic_underscores": "fig.update_traces(gauge_bar_thickness=<VALUE>, selector=dict(type='indicator'))"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='candlestick'))"
},
- "magic_underscores": "fig.update_traces(gauge_bar=dict(...), selector=dict(type='indicator'))"
- },
- "bgcolor": {
- "description": "Sets the gauge background color.",
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(gauge_bgcolor=<VALUE>, selector=dict(type='indicator'))"
- },
- "bordercolor": {
- "description": "Sets the color of the border enclosing the gauge.",
- "dflt": "#444",
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(gauge_bordercolor=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='candlestick'))"
},
- "borderwidth": {
- "description": "Sets the width (in px) of the border enclosing the gauge.",
- "dflt": 1,
- "editType": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(gauge_borderwidth=<VALUE>, selector=dict(type='indicator'))"
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='candlestick'))"
},
- "description": "The gauge of the Indicator plot.",
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='candlestick'))"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "x": {
+ "description": "Sets the x coordinates. If absent, linear coordinate will be generated.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "close": {
+ "description": "Sets the close values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(close=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "open": {
+ "description": "Sets the open values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(open=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "high": {
+ "description": "Sets the high values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(high=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "low": {
+ "description": "Sets the low values.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(low=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "hovertext": {
+ "arrayOk": true,
+ "description": "Same as `text`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines what trace information appears on hover. 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",
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `open`, `high`, `low` and `close`. 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",
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "hovertemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "none",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "line": {
+ "editType": "style",
"role": "object",
- "shape": {
- "description": "Set the shape of the gauge",
- "dflt": "angular",
- "editType": "plot",
- "valType": "enumerated",
- "values": [
- "angular",
- "bullet"
- ],
- "magic_underscores": "fig.update_traces(gauge_shape=<VALUE>, selector=dict(type='indicator'))"
+ "width": {
+ "description": "Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='candlestick'))"
},
- "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"
- }
- }
+ "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='candlestick'))"
+ },
+ "whiskerwidth": {
+ "description": "Sets the width of the whiskers relative to the box width. For example, with 1, the whiskers are as wide as the box(es).",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(whiskerwidth=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "increasing": {
+ "editType": "style",
+ "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",
+ "magic_underscores": "fig.update_traces(increasing_fillcolor=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the color of line bounding the box(es).",
+ "dflt": "#3D9970",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(increasing_line_color=<VALUE>, selector=dict(type='candlestick'))"
},
+ "editType": "style",
"role": "object",
- "magic_underscores": "fig.update_traces(gauge_steps=list(...), selector=dict(type='indicator'))"
+ "width": {
+ "description": "Sets the width (in px) of line bounding the box(es).",
+ "dflt": 2,
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(increasing_line_width=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "magic_underscores": "fig.update_traces(increasing_line=dict(...), selector=dict(type='candlestick'))"
},
- "threshold": {
- "editType": "plot",
- "line": {
- "color": {
- "description": "Sets the color of the threshold line.",
- "dflt": "#444",
- "editType": "plot",
- "valType": "color",
- "magic_underscores": "fig.update_traces(gauge_threshold_line_color=<VALUE>, selector=dict(type='indicator'))"
- },
- "editType": "plot",
- "role": "object",
- "width": {
- "description": "Sets the width (in px) of the threshold line.",
- "dflt": 1,
- "editType": "plot",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(gauge_threshold_line_width=<VALUE>, selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(gauge_threshold_line=dict(...), selector=dict(type='indicator'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(increasing=dict(...), selector=dict(type='candlestick'))"
+ },
+ "decreasing": {
+ "editType": "style",
+ "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",
+ "magic_underscores": "fig.update_traces(decreasing_fillcolor=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "line": {
+ "color": {
+ "description": "Sets the color of line bounding the box(es).",
+ "dflt": "#FF4136",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(decreasing_line_color=<VALUE>, selector=dict(type='candlestick'))"
},
+ "editType": "style",
"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,
+ "width": {
+ "description": "Sets the width (in px) of line bounding the box(es).",
+ "dflt": 2,
+ "editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(gauge_threshold_thickness=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(decreasing_line_width=<VALUE>, selector=dict(type='candlestick'))"
},
- "value": {
- "description": "Sets a treshold value drawn as a line.",
- "dflt": false,
- "editType": "calc",
+ "magic_underscores": "fig.update_traces(decreasing_line=dict(...), selector=dict(type='candlestick'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(decreasing=dict(...), selector=dict(type='candlestick'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(gauge_threshold_value=<VALUE>, selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='candlestick'))"
},
- "magic_underscores": "fig.update_traces(gauge_threshold=dict(...), selector=dict(type='indicator'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='candlestick'))"
},
- "magic_underscores": "fig.update_traces(gauge=dict(...), selector=dict(type='indicator'))"
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "role": "object",
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "split": {
+ "description": "Show hover information (open, close, high, low) in separate labels, rather than a single unified label. Default: *false*. When set to *true*, `hovertemplate` is ignored.",
+ "dflt": false,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_split=<VALUE>, selector=dict(type='candlestick'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='candlestick'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='candlestick'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='indicator'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='indicator'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='candlestick'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='indicator'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='candlestick'))"
},
"categories": [
+ "cartesian",
"svg",
- "noOpacity",
- "noHover"
+ "showLegend",
+ "candlestick",
+ "boxLayout"
],
+ "layoutAttributes": {
+ "boxgap": {
+ "description": "Sets the gap (in plot fraction) between boxes of adjacent location coordinates. Has no effect on traces that have *width* set.",
+ "dflt": 0.3,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "boxgroupgap": {
+ "description": "Sets the gap (in plot fraction) between boxes of the same location coordinate. Has no effect on traces that have *width* set.",
+ "dflt": 0.3,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "boxmode": {
+ "description": "Determines how boxes at the same location coordinate are displayed on the graph. If *group*, the boxes are plotted next to one another centered around the shared location. If *overlay*, the boxes are plotted over one another, you might need to set *opacity* to see them multiple boxes. Has no effect on traces that have *width* set.",
+ "dflt": "overlay",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "group",
+ "overlay"
+ ]
+ }
+ },
"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."
+ "description": "The candlestick is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The boxes represent the spread between the `open` and `close` values and the lines represent the spread between the `low` and `high` values Sample points where the close value is higher (lower) than the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red."
},
- "type": "indicator"
+ "type": "candlestick"
},
- "scatter3d": {
+ "waterfall": {
"animatable": false,
"attributes": {
- "type": "scatter3d",
+ "type": "waterfall",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='waterfall'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='waterfall'))"
},
"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).",
@@ -51477,35 +42729,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='waterfall'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": true,
"editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='waterfall'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='waterfall'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='waterfall'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='waterfall'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -51513,7 +42765,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='waterfall'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -51523,7 +42775,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='waterfall'))"
},
"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.",
@@ -51538,7 +42790,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='waterfall'))"
},
"role": "object",
"shadow": {
@@ -51546,13 +42798,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='waterfall'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='waterfall'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -51563,7 +42815,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='waterfall'))"
},
"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.",
@@ -51576,7 +42828,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='waterfall'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -51591,7 +42843,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='waterfall'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -51604,9 +42856,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='waterfall'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='waterfall'))"
},
"role": "object",
"text": {
@@ -51614,1265 +42866,1579 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='waterfall'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='waterfall'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='waterfall'))"
},
"opacity": {
"description": "Sets the opacity of the trace.",
"dflt": 1,
- "editType": "calc",
+ "editType": "style",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='waterfall'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='waterfall'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
+ "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='waterfall'))"
},
"x": {
"description": "Sets the x coordinates.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='waterfall'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "dx": {
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(dx=<VALUE>, selector=dict(type='waterfall'))"
},
"y": {
"description": "Sets the y coordinates.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='waterfall'))"
},
- "z": {
- "description": "Sets the z coordinates.",
+ "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": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='waterfall'))"
},
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
+ "dy": {
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(dy=<VALUE>, selector=dict(type='waterfall'))"
},
- "surfacecolor": {
- "description": "Sets the surface fill color.",
+ "base": {
+ "arrayOk": false,
+ "description": "Sets where the bar base is drawn (in position axis units).",
+ "dflt": null,
"editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(surfacecolor=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(base=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the bar width (in position axis units).",
+ "dflt": null,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "measure": {
+ "description": "An array containing types of values. By default the values are considered as 'relative'. However; it is possible to use 'total' to compute the sums. Also 'absolute' could be applied to reset the computed total or to declare an initial value where needed.",
+ "dflt": [],
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(measure=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "offset": {
+ "arrayOk": true,
+ "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",
+ "magic_underscores": "fig.update_traces(offset=<VALUE>, selector=dict(type='waterfall'))"
},
"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.",
+ "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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='waterfall'))"
},
"textposition": {
"arrayOk": true,
- "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
- "dflt": "top center",
+ "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": [
- "top left",
- "top center",
- "top right",
- "middle left",
- "middle center",
- "middle right",
- "bottom left",
- "bottom center",
- "bottom right"
+ "inside",
+ "outside",
+ "auto",
+ "none"
],
- "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='waterfall'))"
},
"texttemplate": {
"arrayOk": true,
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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 appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `initial`, `delta`, `final` and `label`.",
"dflt": "",
- "editType": "calc",
+ "editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='waterfall'))"
},
"texttemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
- "editType": "calc",
+ "editType": "plot",
"valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='waterfall'))"
},
"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.",
+ "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",
+ "editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='waterfall'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
+ "name",
"x",
"y",
- "z",
"text",
- "name"
+ "initial",
+ "delta",
+ "final"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='waterfall'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `initial`, `delta` and `final`. 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='waterfall'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
- "editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
"editType": "none",
- "valType": "string"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='waterfall'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
+ "editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='waterfall'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
+ "editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='waterfall'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='waterfall'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='waterfall'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='waterfall'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='waterfall'))"
},
- "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,
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yperiod=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(yperiodalignment=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yperiod0=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textangle=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
"editType": "calc",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='scatter3d'))"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='waterfall'))"
},
- "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,
+ "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",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='scatter3d'))"
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='waterfall'))"
},
- "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",
+ "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",
- "impliedEdits": {
- "cauto": false,
- "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='waterfall'))"
},
- "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,
+ "size": {
+ "arrayOk": true,
"editType": "calc",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='waterfall'))"
},
- "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,
+ "style": {
+ "arrayOk": true,
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
"editType": "calc",
- "impliedEdits": {
- "cauto": false,
- "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "italic"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='waterfall'))"
},
- "color": {
+ "textcase": {
"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.",
+ "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": "color",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='waterfall'))"
},
- "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,
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "calc",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
- "valType": "subplotid",
- "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='waterfall'))"
},
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='scatter3d'))"
- },
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='waterfall'))"
+ },
+ "textinfo": {
+ "arrayOk": false,
+ "description": "Determines what trace information appears on the graph. In the case of having multiple waterfalls, totals are computed separately (per trace). Flags are rendered in a fixed order; use `texttemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "initial",
+ "delta",
+ "final"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(textinfo=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(cliponaxis=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "connector": {
+ "editType": "plot",
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(connector_line_color=<VALUE>, selector=dict(type='waterfall'))"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "calc",
- "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": [
- "all",
- "first",
- "last",
- "none"
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(connector_line_dash=<VALUE>, selector=dict(type='waterfall'))"
},
- "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": "plot",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "plot",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(connector_line_width=<VALUE>, selector=dict(type='waterfall'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(connector_line=dict(...), selector=dict(type='waterfall'))"
+ },
+ "mode": {
+ "description": "Sets the shape of connector lines.",
+ "dflt": "between",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "spanning",
+ "between"
+ ],
+ "magic_underscores": "fig.update_traces(connector_mode=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "role": "object",
+ "visible": {
+ "description": "Determines if connector lines are drawn. ",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(connector_visible=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "magic_underscores": "fig.update_traces(connector=dict(...), selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(constraintext=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "increasing": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "arrayOk": false,
+ "description": "Sets the marker color of all increasing values.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(increasing_marker_color=<VALUE>, selector=dict(type='waterfall'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "editType": "style",
+ "line": {
+ "color": {
+ "arrayOk": false,
+ "description": "Sets the line color of all increasing values.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(increasing_marker_line_color=<VALUE>, selector=dict(type='waterfall'))"
},
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='scatter3d'))"
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "arrayOk": false,
+ "description": "Sets the line width of all increasing values.",
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(increasing_marker_line_width=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "magic_underscores": "fig.update_traces(increasing_marker_line=dict(...), selector=dict(type='waterfall'))"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "calc",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(increasing_marker=dict(...), selector=dict(type='waterfall'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(increasing=dict(...), selector=dict(type='waterfall'))"
+ },
+ "decreasing": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "arrayOk": false,
+ "description": "Sets the marker color of all decreasing values.",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(decreasing_marker_color=<VALUE>, selector=dict(type='waterfall'))"
},
- "tickfont": {
+ "editType": "style",
+ "line": {
"color": {
- "editType": "calc",
+ "arrayOk": false,
+ "description": "Sets the line color of all decreasing values.",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(decreasing_marker_line_color=<VALUE>, selector=dict(type='waterfall'))"
},
+ "editType": "style",
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "size": {
- "editType": "calc",
- "min": 1,
+ "width": {
+ "arrayOk": false,
+ "description": "Sets the line width of all decreasing values.",
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(decreasing_marker_line_width=<VALUE>, selector=dict(type='waterfall'))"
},
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(decreasing_marker_line=dict(...), selector=dict(type='waterfall'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='scatter3d'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(decreasing_marker=dict(...), selector=dict(type='waterfall'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(decreasing=dict(...), selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='waterfall'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='scatter3d'))"
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='waterfall'))"
},
- "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": {
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
+ "flags": [
+ "under",
+ "over",
+ "through"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='waterfall'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scatter3d'))"
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='waterfall'))"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "calc",
- "min": 0,
+ "size": {
+ "arrayOk": true,
+ "editType": "none",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='waterfall'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
+ "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": [
- "auto",
- "linear",
- "array"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='waterfall'))"
},
- "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": {
+ "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": [
- "outside",
- "inside",
- ""
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='waterfall'))"
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='waterfall'))"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "none",
- "valType": "string"
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='waterfall'))"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "role": "object",
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextanchor=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "insidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='waterfall'))"
+ },
+ "outsidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='waterfall'))"
+ },
+ "totals": {
+ "editType": "style",
+ "marker": {
+ "color": {
+ "arrayOk": false,
+ "description": "Sets the marker color of all intermediate sums and total values.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(totals_marker_color=<VALUE>, selector=dict(type='waterfall'))"
},
- "title": {
- "editType": "calc",
- "font": {
- "color": {
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='scatter3d'))"
+ "editType": "style",
+ "line": {
+ "color": {
+ "arrayOk": false,
+ "description": "Sets the line color of all intermediate sums and total values.",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(totals_marker_line_color=<VALUE>, selector=dict(type='waterfall'))"
},
+ "editType": "style",
"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*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='scatter3d'))"
+ "width": {
+ "arrayOk": false,
+ "description": "Sets the line width of all intermediate sums and total values.",
+ "dflt": 0,
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(totals_marker_line_width=<VALUE>, selector=dict(type='waterfall'))"
},
- "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(totals_marker_line=dict(...), selector=dict(type='waterfall'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='scatter3d'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(totals_marker=dict(...), selector=dict(type='waterfall'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(totals=dict(...), selector=dict(type='waterfall'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='waterfall'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='waterfall'))"
+ },
+ "categories": [
+ "bar-like",
+ "cartesian",
+ "svg",
+ "oriented",
+ "showLegend",
+ "zoomScale"
+ ],
+ "layoutAttributes": {
+ "waterfallgap": {
+ "description": "Sets the gap (in plot fraction) between bars of adjacent location coordinates.",
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "waterfallgroupgap": {
+ "description": "Sets the gap (in plot fraction) between bars of the same location coordinate.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ "waterfallmode": {
+ "description": "Determines how bars at the same location coordinate are displayed on the graph. 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": [
+ "group",
+ "overlay"
+ ]
+ }
+ },
+ "meta": {
+ "description": "Draws waterfall trace which is useful graph to displays the contribution of various elements (either positive or negative) in a bar chart. The data visualized by the span of the bars is set in `y` if `orientation` is set to *v* (the default) and the labels are set in `x`. By setting `orientation` to *h*, the roles are interchanged."
+ },
+ "type": "waterfall"
+ },
+ "funnel": {
+ "animatable": false,
+ "attributes": {
+ "type": "funnel",
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='funnel'))"
},
- "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"
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='scatter3d'))"
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='funnel'))"
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
+ "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='funnel'))"
},
- "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": {
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='funnel'))"
},
- "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": {
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='funnel'))"
},
- "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": {
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scatter3d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_line_autocolorscale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_cauto_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_line_cauto=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_cmax_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmax=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_cmid_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmid=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_cmin_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmin=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_colorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_reversescale=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='funnel'))"
},
- "role": "object",
- "width": {
- "arrayOk": false,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scatter3d'))"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "size": {
- "arrayOk": true,
- "description": "Sets the marker size (in px).",
- "dflt": 8,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_sizemin=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_sizemode=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='funnel'))"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(zorder=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "x": {
+ "description": "Sets the x coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(x0=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "dx": {
+ "description": "Sets the x coordinate step. See `x0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(dx=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "y": {
+ "description": "Sets the y coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(y0=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "dy": {
+ "description": "Sets the y coordinate step. See `y0` for more info.",
+ "dflt": 1,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(dy=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "width": {
+ "arrayOk": false,
+ "description": "Sets the bar width (in position axis units).",
+ "dflt": null,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(offset=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "texttemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "plot",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines what trace information appears on hover. 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",
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "hovertemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "none",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xaxis=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yaxis=<VALUE>, selector=dict(type='funnel'))"
},
- "line": {
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(orientation=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(alignmentgroup=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(offsetgroup=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xperiodalignment=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(xperiod0=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yperiod=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(yperiodalignment=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(yperiod0=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "marker": {
"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.",
+ "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": {
- "magic_underscores": "fig.update_traces(line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(line_autocolorscale=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='funnel'))"
},
"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.",
+ "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": {
- "magic_underscores": "fig.update_traces(line_cauto_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(line_cauto=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='funnel'))"
},
"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.",
+ "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,
- "magic_underscores": "fig.update_traces(line_cmax_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(line_cmax=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='funnel'))"
},
"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`.",
+ "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": {
- "magic_underscores": "fig.update_traces(line_cmid_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(line_cmid=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='funnel'))"
},
"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.",
+ "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,
- "magic_underscores": "fig.update_traces(line_cmin_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(line_cmin=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='funnel'))"
},
"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",
+ "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",
- "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='funnel'))"
},
"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.",
@@ -52880,46 +44446,46 @@
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(line_coloraxis=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='funnel'))"
},
"colorbar": {
"bgcolor": {
"description": "Sets the color of padded area.",
"dflt": "rgba(0,0,0,0)",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_colorbar_bgcolor=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='funnel'))"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_colorbar_bordercolor=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='funnel'))"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
"dflt": 0,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_colorbar_borderwidth=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(line_colorbar_dtick=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='funnel'))"
},
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
"dflt": "B",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"none",
@@ -52930,88 +44496,88 @@
"B",
"SI extended"
],
- "magic_underscores": "fig.update_traces(line_colorbar_exponentformat=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='funnel'))"
},
"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 \u22121 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",
- "magic_underscores": "fig.update_traces(line_colorbar_labelalias=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_len=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='funnel'))"
},
"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",
"pixels"
],
- "magic_underscores": "fig.update_traces(line_colorbar_lenmode=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_minexponent=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_nticks=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='funnel'))"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
"dflt": "v",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"h",
"v"
],
- "magic_underscores": "fig.update_traces(line_colorbar_orientation=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='funnel'))"
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_colorbar_outlinecolor=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='funnel'))"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
"dflt": 1,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_colorbar_outlinewidth=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='funnel'))"
},
"role": "object",
"separatethousands": {
"description": "If \"true\", even 4-digit integers are separated",
"dflt": false,
- "editType": "calc",
+ "editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(line_colorbar_separatethousands=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='funnel'))"
},
"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",
@@ -53019,19 +44585,19 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(line_colorbar_showexponent=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='funnel'))"
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "calc",
+ "editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(line_colorbar_showticklabels=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='funnel'))"
},
"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",
@@ -53039,12 +44605,12 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(line_colorbar_showtickprefix=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='funnel'))"
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
"dflt": "all",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"all",
@@ -53052,71 +44618,71 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(line_colorbar_showticksuffix=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_thickness=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='funnel'))"
},
"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",
"pixels"
],
- "magic_underscores": "fig.update_traces(line_colorbar_thicknessmode=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(line_colorbar_tick0=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_tickangle=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='funnel'))"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_colorbar_tickcolor=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='funnel'))"
},
"tickfont": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_color=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='funnel'))"
},
"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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_family=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='funnel'))"
},
"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"
],
@@ -53126,37 +44692,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='funnel'))"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_size=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='funnel'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_style=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='funnel'))"
},
"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",
@@ -53164,12 +44730,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='funnel'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -53179,12 +44745,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='funnel'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -53192,79 +44758,79 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(line_colorbar_tickfont=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_tickformat=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='funnel'))"
},
"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",
+ "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"
}
}
},
"role": "object",
- "magic_underscores": "fig.update_traces(line_colorbar_tickformatstops=list(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='funnel'))"
},
"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",
"hide past div",
"hide past domain"
],
- "magic_underscores": "fig.update_traces(line_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='funnel'))"
},
"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",
@@ -53278,29 +44844,29 @@
"outside bottom",
"inside bottom"
],
- "magic_underscores": "fig.update_traces(line_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='funnel'))"
},
"ticklen": {
"description": "Sets the tick length (in px).",
"dflt": 5,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_colorbar_ticklen=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='funnel'))"
},
"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": {
- "magic_underscores": "fig.update_traces(line_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
},
"valType": "enumerated",
"values": [
@@ -53308,86 +44874,76 @@
"linear",
"array"
],
- "magic_underscores": "fig.update_traces(line_colorbar_tickmode=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='funnel'))"
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(line_colorbar_tickprefix=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='funnel'))"
},
"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",
"inside",
""
],
- "magic_underscores": "fig.update_traces(line_colorbar_ticks=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='funnel'))"
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(line_colorbar_ticksuffix=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_ticktext=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_tickvals=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='funnel'))"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
"dflt": 1,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_colorbar_tickwidth=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='funnel'))"
},
"title": {
- "editType": "calc",
+ "editType": "colorbars",
"font": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_color=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='funnel'))"
},
"description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_family=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='funnel'))"
},
"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"
],
@@ -53397,37 +44953,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='funnel'))"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_size=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='funnel'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_style=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='funnel'))"
},
"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",
@@ -53435,12 +44991,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='funnel'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -53450,12 +45006,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_variant=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='funnel'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -53463,174 +45019,257 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(line_colorbar_title_font_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(line_colorbar_title_font=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='funnel'))"
},
"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*.",
- "editType": "calc",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"right",
"top",
"bottom"
],
- "magic_underscores": "fig.update_traces(line_colorbar_title_side=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='funnel'))"
},
"text": {
"description": "Sets the title of the color bar.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(line_colorbar_title_text=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(line_colorbar_title=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='funnel'))"
},
"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",
- "magic_underscores": "fig.update_traces(line_colorbar_x=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='funnel'))"
},
"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",
"center",
"right"
],
- "magic_underscores": "fig.update_traces(line_colorbar_xanchor=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='funnel'))"
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
"dflt": 10,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_colorbar_xpad=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='funnel'))"
},
"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",
"paper"
],
- "magic_underscores": "fig.update_traces(line_colorbar_xref=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='funnel'))"
+ },
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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,
+ "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_line_autocolorscale=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_cauto_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_line_cauto=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_line_cmax_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmax=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_cmid_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmid=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_line_cmin_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmin=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='funnel'))"
},
- "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*.",
+ "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",
- "magic_underscores": "fig.update_traces(line_colorbar_y=<VALUE>, selector=dict(type='scatter3d'))"
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid",
+ "magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='funnel'))"
},
- "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*.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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",
- "valType": "enumerated",
- "values": [
- "top",
- "middle",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(line_colorbar_yanchor=<VALUE>, selector=dict(type='scatter3d'))"
+ "impliedEdits": {
+ "autocolorscale": false,
+ "magic_underscores": "fig.update_traces(marker_line_colorscale_impliedEdits=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='funnel'))"
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_reversescale=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(line_colorbar_ypad=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(line_colorbar_yref=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(line_colorbar=dict(...), selector=dict(type='scatter3d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(line_colorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='funnel'))"
},
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(line_colorscale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='funnel'))"
},
- "dash": {
- "description": "Sets the dash style of the lines.",
- "dflt": "solid",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "dash",
- "dashdot",
- "dot",
- "longdash",
- "longdashdot",
- "solid"
- ],
- "magic_underscores": "fig.update_traces(line_dash=<VALUE>, selector=dict(type='scatter3d'))"
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the opacity of the bars.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='funnel'))"
},
- "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.",
+ "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",
- "magic_underscores": "fig.update_traces(line_reversescale=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='funnel'))"
},
"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.",
+ "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",
- "magic_underscores": "fig.update_traces(line_showscale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textangle=<VALUE>, selector=dict(type='funnel'))"
},
"textfont": {
"color": {
"arrayOk": true,
- "editType": "calc",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='funnel'))"
},
- "description": "Sets the text font.",
+ "description": "Sets the font used for `text`.",
"editType": "calc",
"family": {
"arrayOk": true,
@@ -53639,25 +45278,39 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='funnel'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='funnel'))"
},
"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",
+ "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='funnel'))"
+ },
"size": {
"arrayOk": true,
"editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='funnel'))"
},
"style": {
"arrayOk": true,
@@ -53669,12 +45322,21 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='funnel'))"
},
- "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='funnel'))"
},
"variant": {
"arrayOk": true,
@@ -53684,14 +45346,13 @@
"valType": "enumerated",
"values": [
"normal",
- "small-caps"
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
],
- "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='funnel'))"
},
"weight": {
"arrayOk": true,
@@ -53705,344 +45366,106 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='funnel'))"
},
- "error_x": {
- "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",
- "magic_underscores": "fig.update_traces(error_x_array=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_x_arrayminus=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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 stroke color of the error bars.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(error_x_color=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "copy_zstyle": {
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(error_x_copy_zstyle=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_x_symmetric=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_x_thickness=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "traceref": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_x_traceref=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_x_tracerefminus=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(error_x_type=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_x_value=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_x_valueminus=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(error_x_visible=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_x_width=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(error_x=dict(...), selector=dict(type='scatter3d'))"
+ "textinfo": {
+ "arrayOk": false,
+ "description": "Determines what trace information appears on the graph. In the case of having multiple funnels, percentages & totals are computed separately (per trace). Flags are rendered in a fixed order; use `texttemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
+ "editType": "plot",
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "percent initial",
+ "percent previous",
+ "percent total",
+ "value"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(textinfo=<VALUE>, selector=dict(type='funnel'))"
},
- "error_y": {
- "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",
- "magic_underscores": "fig.update_traces(error_y_array=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_y_arrayminus=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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 stroke color of the error bars.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(error_y_color=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "copy_zstyle": {
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(error_y_copy_zstyle=<VALUE>, selector=dict(type='scatter3d'))"
- },
+ "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",
- "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",
- "magic_underscores": "fig.update_traces(error_y_symmetric=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_y_thickness=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "traceref": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_y_traceref=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_y_tracerefminus=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(error_y_type=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_y_value=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_y_valueminus=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(error_y_visible=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_y_width=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(error_y=dict(...), selector=dict(type='scatter3d'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='funnel'))"
},
- "error_z": {
- "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",
- "magic_underscores": "fig.update_traces(error_z_array=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_z_arrayminus=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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 stroke color of the error bars.",
- "editType": "calc",
+ "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",
+ "magic_underscores": "fig.update_traces(cliponaxis=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "connector": {
+ "editType": "plot",
+ "fillcolor": {
+ "description": "Sets the fill color.",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(error_z_color=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_z_symmetric=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "thickness": {
- "description": "Sets the thickness (in px) of the error bars.",
- "dflt": 2,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_z_thickness=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "traceref": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_z_traceref=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "tracerefminus": {
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(error_z_tracerefminus=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(error_z_type=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(error_z_value=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(connector_fillcolor=<VALUE>, selector=dict(type='funnel'))"
},
- "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",
- "magic_underscores": "fig.update_traces(error_z_valueminus=<VALUE>, selector=dict(type='scatter3d'))"
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
+ "dflt": "#444",
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(connector_line_color=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(connector_line_dash=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "editType": "style",
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 0,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(connector_line_width=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "magic_underscores": "fig.update_traces(connector_line=dict(...), selector=dict(type='funnel'))"
},
+ "role": "object",
"visible": {
- "description": "Determines whether or not this set of error bars is visible.",
- "editType": "calc",
+ "description": "Determines if connector regions and lines are drawn.",
+ "dflt": true,
+ "editType": "plot",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(error_z_visible=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "width": {
- "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(error_z_width=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(connector_visible=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(error_z=dict(...), selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='scatter3d'))"
+ "magic_underscores": "fig.update_traces(connector=dict(...), selector=dict(type='funnel'))"
},
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
- "dflt": false,
+ "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": "boolean",
- "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='scatter3d'))"
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "outside",
+ "both",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(constraintext=<VALUE>, selector=dict(type='funnel'))"
},
"hoverlabel": {
"align": {
@@ -54056,36 +45479,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='funnel'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='funnel'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='funnel'))"
},
"editType": "none",
"font": {
@@ -54093,12 +45501,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='funnel'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -54109,12 +45512,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='funnel'))"
},
"lineposition": {
"arrayOk": true,
@@ -54130,12 +45528,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='funnel'))"
},
"role": "object",
"shadow": {
@@ -54144,24 +45537,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='funnel'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='funnel'))"
},
"style": {
"arrayOk": true,
@@ -54173,12 +45556,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='funnel'))"
},
"textcase": {
"arrayOk": true,
@@ -54192,435 +45570,13 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='scatter3d'))"
- },
- "projection": {
- "editType": "calc",
- "role": "object",
- "x": {
- "editType": "calc",
- "opacity": {
- "description": "Sets the projection color.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(projection_x_opacity=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(projection_x_scale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "show": {
- "description": "Sets whether or not projections are shown along the x axis.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(projection_x_show=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(projection_x=dict(...), selector=dict(type='scatter3d'))"
- },
- "y": {
- "editType": "calc",
- "opacity": {
- "description": "Sets the projection color.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(projection_y_opacity=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(projection_y_scale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "show": {
- "description": "Sets whether or not projections are shown along the y axis.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(projection_y_show=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(projection_y=dict(...), selector=dict(type='scatter3d'))"
- },
- "z": {
- "editType": "calc",
- "opacity": {
- "description": "Sets the projection color.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(projection_z_opacity=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(projection_z_scale=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "show": {
- "description": "Sets whether or not projections are shown along the z axis.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(projection_z_show=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(projection_z=dict(...), selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(projection=dict(...), selector=dict(type='scatter3d'))"
- },
- "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
- ],
- "magic_underscores": "fig.update_traces(surfaceaxis=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(zcalendar=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scatter3d'))"
- },
- "magic_underscores": "fig.update_traces(..., selector=dict(type='scatter3d'))"
- },
- "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"
- },
- "surface": {
- "animatable": false,
- "attributes": {
- "type": "surface",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='surface'))"
- },
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='surface'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='surface'))"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='surface'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='surface'))"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='funnel'))"
},
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"valType": "enumerated",
"values": [
"normal",
@@ -54630,12 +45586,13 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='funnel'))"
},
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "none",
"extras": [
"normal",
"bold"
@@ -54643,449 +45600,347 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='funnel'))"
},
"role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='surface'))"
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='funnel'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='surface'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='surface'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "x": {
- "description": "Sets the x coordinates.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='surface'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
- "surfacecolor": {
- "description": "Sets the surface color values, used for setting a color scale independent of `z`.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(surfacecolor=<VALUE>, selector=dict(type='surface'))"
- },
- "surfacecolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `surfacecolor`.",
- "editType": "none",
- "valType": "string"
- },
- "text": {
- "arrayOk": true,
- "description": "Sets the text elements associated with each z value. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='surface'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='surface'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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": "calc",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='surface'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='surface'))"
- },
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='surface'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='funnel'))"
},
- "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.",
+ "insidetextanchor": {
+ "description": "Determines if texts are kept at center or start/end points in `textposition` *inside* mode.",
+ "dflt": "middle",
"editType": "plot",
- "valType": "any",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='surface'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='surface'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='surface'))"
+ "valType": "enumerated",
+ "values": [
+ "end",
+ "middle",
+ "start"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextanchor=<VALUE>, selector=dict(type='funnel'))"
},
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='surface'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
+ "insidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='surface'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='funnel'))"
},
- "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*",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
"editType": "calc",
- "impliedEdits": {
- "tickmode": "linear",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='surface'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='surface'))"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='funnel'))"
},
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "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",
- "SI extended"
+ "extras": [
+ "none"
],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='surface'))"
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='funnel'))"
},
- "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 \u22121 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,
+ "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": "any",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='surface'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='funnel'))"
},
- "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,
+ "size": {
+ "arrayOk": true,
"editType": "calc",
- "min": 0,
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='funnel'))"
},
- "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",
+ "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": [
- "fraction",
- "pixels"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='funnel'))"
},
- "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,
+ "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": "integer",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='surface'))"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='funnel'))"
},
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "calc",
"valType": "enumerated",
"values": [
- "h",
- "v"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='funnel'))"
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='surface'))"
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='funnel'))"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='funnel'))"
+ },
+ "outsidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='funnel'))"
},
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
"editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='surface'))"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='funnel'))"
},
- "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",
+ "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": [
- "all",
- "first",
- "last",
+ "extras": [
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='surface'))"
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='funnel'))"
},
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
+ "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": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='surface'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='funnel'))"
},
- "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",
+ "size": {
+ "arrayOk": true,
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='surface'))"
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='funnel'))"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
+ "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": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='funnel'))"
},
- "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",
+ "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": [
- "fraction",
- "pixels"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='surface'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='funnel'))"
},
- "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",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
"editType": "calc",
- "valType": "angle",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='surface'))"
+ "valType": "enumerated",
+ "values": [
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
+ ],
+ "magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='funnel'))"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
"editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='surface'))"
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='funnel'))"
},
- "tickfont": {
+ "magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='funnel'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='funnel'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='funnel'))"
+ },
+ "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",
+ "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."
+ },
+ "type": "funnel"
+ },
+ "funnelarea": {
+ "animatable": false,
+ "attributes": {
+ "type": "funnelarea",
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "title": {
+ "editType": "plot",
+ "font": {
"color": {
- "editType": "calc",
+ "arrayOk": true,
+ "editType": "plot",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_color=<VALUE>, selector=dict(type='funnelarea'))"
},
- "description": "Sets the color bar's tick label font",
- "editType": "calc",
+ "description": "Sets the font used for `title`.",
+ "editType": "plot",
"family": {
+ "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_family=<VALUE>, selector=dict(type='funnelarea'))"
},
"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": "plot",
"extras": [
"none"
],
@@ -55095,37 +45950,41 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
},
"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": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_shadow=<VALUE>, selector=dict(type='funnelarea'))"
},
"size": {
- "editType": "calc",
+ "arrayOk": true,
+ "editType": "plot",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_size=<VALUE>, selector=dict(type='funnelarea'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_style=<VALUE>, selector=dict(type='funnelarea'))"
},
"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": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -55133,12 +45992,13 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_textcase=<VALUE>, selector=dict(type='funnelarea'))"
},
"variant": {
+ "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -55148,12 +46008,13 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_variant=<VALUE>, selector=dict(type='funnelarea'))"
},
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -55161,795 +46022,644 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='surface'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='surface'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='surface'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font_weight=<VALUE>, selector=dict(type='funnelarea'))"
},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='surface'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_font=dict(...), selector=dict(type='funnelarea'))"
},
- "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",
+ "position": {
+ "description": "Specifies the location of the `title`.",
+ "dflt": "top center",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- ""
+ "top left",
+ "top center",
+ "top right"
],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_position=<VALUE>, selector=dict(type='funnelarea'))"
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the chart. If it is empty, no title is displayed.",
"dflt": "",
- "editType": "calc",
+ "editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title_text=<VALUE>, selector=dict(type='funnelarea'))"
},
- "title": {
- "editType": "calc",
- "font": {
- "color": {
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='surface'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='surface'))"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='surface'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='surface'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(title=dict(...), selector=dict(type='funnelarea'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='funnelarea'))"
},
- "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*.",
- "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": [
- "right",
- "top",
- "bottom"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='funnelarea'))"
},
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='surface'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='surface'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='surface'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='surface'))"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='surface'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='surface'))"
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='funnelarea'))"
},
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='funnelarea'))"
},
- "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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='surface'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='surface'))"
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='funnelarea'))"
},
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='surface'))"
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='funnelarea'))"
},
- "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,
+ "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": "boolean",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='surface'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='funnelarea'))"
},
- "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": "",
+ "values": {
+ "description": "Sets the values of the sectors. If omitted, we count occurrences of each label.",
"editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='surface'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(values=<VALUE>, selector=dict(type='funnelarea'))"
},
- "cauto": {
- "description": "Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
- "dflt": true,
+ "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",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='surface'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='surface'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(labels=<VALUE>, selector=dict(type='funnelarea'))"
},
- "cmax": {
- "description": "Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well.",
- "dflt": null,
+ "dlabel": {
+ "description": "Sets the label step. See `label0` for more info.",
+ "dflt": 1,
"editType": "calc",
- "impliedEdits": {
- "cauto": false,
- "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='surface'))"
- },
"valType": "number",
- "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(dlabel=<VALUE>, selector=dict(type='funnelarea'))"
},
- "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 z or surfacecolor. Has no effect when `cauto` is `false`.",
- "dflt": null,
+ "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",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='surface'))"
- },
"valType": "number",
- "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(label0=<VALUE>, selector=dict(type='funnelarea'))"
},
- "cmin": {
- "description": "Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well.",
- "dflt": null,
- "editType": "calc",
- "impliedEdits": {
- "cauto": false,
- "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='surface'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='surface'))"
+ "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",
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='funnelarea'))"
},
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.",
- "dflt": false,
+ "textposition": {
+ "arrayOk": true,
+ "description": "Specifies the location of the `textinfo`.",
+ "dflt": "inside",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "inside",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "texttemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "plot",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines what trace information appears on hover. Flags are rendered in a fixed order; use `hovertemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
+ "dflt": "all",
+ "editType": "none",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "value",
+ "percent",
+ "name"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "hovertemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "none",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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": "boolean",
- "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='surface'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='funnelarea'))"
},
- "contours": {
+ "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",
+ "magic_underscores": "fig.update_traces(domain_column=<VALUE>, selector=dict(type='funnelarea'))"
+ },
"editType": "calc",
"role": "object",
- "x": {
- "color": {
- "description": "Sets the color of the contour lines.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(contours_x_color=<VALUE>, selector=dict(type='surface'))"
- },
+ "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",
- "end": {
- "description": "Sets the end contour level value. Must be more than `contours.start`",
- "dflt": null,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_x_end=<VALUE>, selector=dict(type='surface'))"
- },
- "highlight": {
- "description": "Determines whether or not contour lines about the x dimension are highlighted on hover.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_x_highlight=<VALUE>, selector=dict(type='surface'))"
- },
- "highlightcolor": {
- "description": "Sets the color of the highlighted contour lines.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(contours_x_highlightcolor=<VALUE>, selector=dict(type='surface'))"
- },
- "highlightwidth": {
- "description": "Sets the width of the highlighted contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_x_highlightwidth=<VALUE>, selector=dict(type='surface'))"
- },
- "project": {
- "editType": "calc",
- "role": "object",
- "x": {
- "description": "Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_x_project_x=<VALUE>, selector=dict(type='surface'))"
- },
- "y": {
- "description": "Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_x_project_y=<VALUE>, selector=dict(type='surface'))"
- },
- "z": {
- "description": "Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_x_project_z=<VALUE>, selector=dict(type='surface'))"
- },
- "magic_underscores": "fig.update_traces(contours_x_project=dict(...), selector=dict(type='surface'))"
- },
- "role": "object",
- "show": {
- "description": "Determines whether or not contour lines about the x dimension are drawn.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_x_show=<VALUE>, selector=dict(type='surface'))"
- },
- "size": {
- "description": "Sets the step between each contour level. Must be positive.",
- "dflt": null,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_x_size=<VALUE>, selector=dict(type='surface'))"
- },
- "start": {
- "description": "Sets the starting contour level value. Must be less than `contours.end`",
- "dflt": null,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_x_start=<VALUE>, selector=dict(type='surface'))"
- },
- "usecolormap": {
- "description": "An alternate to *color*. Determines whether or not the contour lines are colored using the trace *colorscale*.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_x_usecolormap=<VALUE>, selector=dict(type='surface'))"
- },
- "width": {
- "description": "Sets the width of the contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_x_width=<VALUE>, selector=dict(type='surface'))"
- },
- "magic_underscores": "fig.update_traces(contours_x=dict(...), selector=dict(type='surface'))"
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(domain_row=<VALUE>, selector=dict(type='funnelarea'))"
},
- "y": {
- "color": {
- "description": "Sets the color of the contour lines.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(contours_y_color=<VALUE>, selector=dict(type='surface'))"
- },
+ "x": {
+ "description": "Sets the horizontal domain of this funnelarea trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
"editType": "calc",
- "end": {
- "description": "Sets the end contour level value. Must be more than `contours.start`",
- "dflt": null,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_y_end=<VALUE>, selector=dict(type='surface'))"
- },
- "highlight": {
- "description": "Determines whether or not contour lines about the y dimension are highlighted on hover.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_y_highlight=<VALUE>, selector=dict(type='surface'))"
- },
- "highlightcolor": {
- "description": "Sets the color of the highlighted contour lines.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(contours_y_highlightcolor=<VALUE>, selector=dict(type='surface'))"
- },
- "highlightwidth": {
- "description": "Sets the width of the highlighted contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_y_highlightwidth=<VALUE>, selector=dict(type='surface'))"
- },
- "project": {
- "editType": "calc",
- "role": "object",
- "x": {
- "description": "Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
+ "items": [
+ {
"editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_y_project_x=<VALUE>, selector=dict(type='surface'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "y": {
- "description": "Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array",
+ "magic_underscores": "fig.update_traces(domain_x=list(...), selector=dict(type='funnelarea'))"
+ },
+ "y": {
+ "description": "Sets the vertical domain of this funnelarea trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
+ ],
+ "editType": "calc",
+ "items": [
+ {
"editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_y_project_y=<VALUE>, selector=dict(type='surface'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
},
- "z": {
- "description": "Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
+ {
"editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_y_project_z=<VALUE>, selector=dict(type='surface'))"
- },
- "magic_underscores": "fig.update_traces(contours_y_project=dict(...), selector=dict(type='surface'))"
- },
- "role": "object",
- "show": {
- "description": "Determines whether or not contour lines about the y dimension are drawn.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_y_show=<VALUE>, selector=dict(type='surface'))"
- },
- "size": {
- "description": "Sets the step between each contour level. Must be positive.",
- "dflt": null,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_y_size=<VALUE>, selector=dict(type='surface'))"
- },
- "start": {
- "description": "Sets the starting contour level value. Must be less than `contours.end`",
- "dflt": null,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_y_start=<VALUE>, selector=dict(type='surface'))"
- },
- "usecolormap": {
- "description": "An alternate to *color*. Determines whether or not the contour lines are colored using the trace *colorscale*.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_y_usecolormap=<VALUE>, selector=dict(type='surface'))"
- },
- "width": {
- "description": "Sets the width of the contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_y_width=<VALUE>, selector=dict(type='surface'))"
- },
- "magic_underscores": "fig.update_traces(contours_y=dict(...), selector=dict(type='surface'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
+ ],
+ "valType": "info_array",
+ "magic_underscores": "fig.update_traces(domain_y=list(...), selector=dict(type='funnelarea'))"
},
- "z": {
+ "magic_underscores": "fig.update_traces(domain=dict(...), selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colors=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "editType": "calc",
+ "line": {
"color": {
- "description": "Sets the color of the contour lines.",
- "dflt": "#444",
- "editType": "calc",
+ "arrayOk": true,
+ "description": "Sets the color of the line enclosing each sector. Defaults to the `paper_bgcolor` value.",
+ "dflt": null,
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(contours_z_color=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='funnelarea'))"
},
"editType": "calc",
- "end": {
- "description": "Sets the end contour level value. Must be more than `contours.start`",
- "dflt": null,
- "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",
- "magic_underscores": "fig.update_traces(contours_z_end=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='funnelarea'))"
},
- "highlight": {
- "description": "Determines whether or not contour lines about the z dimension are highlighted on hover.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_z_highlight=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='funnelarea'))"
},
- "highlightcolor": {
- "description": "Sets the color of the highlighted contour lines.",
- "dflt": "#444",
- "editType": "calc",
+ "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",
- "magic_underscores": "fig.update_traces(contours_z_highlightcolor=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='funnelarea'))"
},
- "highlightwidth": {
- "description": "Sets the width of the highlighted contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
+ "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",
- "magic_underscores": "fig.update_traces(contours_z_highlightwidth=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(marker_pattern_fgopacity=<VALUE>, selector=dict(type='funnelarea'))"
},
- "project": {
- "editType": "calc",
- "role": "object",
- "x": {
- "description": "Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_z_project_x=<VALUE>, selector=dict(type='surface'))"
- },
- "y": {
- "description": "Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_z_project_y=<VALUE>, selector=dict(type='surface'))"
- },
- "z": {
- "description": "Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_z_project_z=<VALUE>, selector=dict(type='surface'))"
- },
- "magic_underscores": "fig.update_traces(contours_z_project=dict(...), selector=dict(type='surface'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_pattern_fillmode=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "path": {
+ "arrayOk": true,
+ "description": "Sets a custom path for pattern fill. Use with no `shape` or `solidity`, provide an SVG path string for the regions of the square from (0,0) to (`size`,`size`) to color.",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='funnelarea'))"
},
"role": "object",
- "show": {
- "description": "Determines whether or not contour lines about the z dimension are drawn.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_z_show=<VALUE>, selector=dict(type='surface'))"
+ "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",
+ "-",
+ "|",
+ "+",
+ "."
+ ],
+ "magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='funnelarea'))"
},
"size": {
- "description": "Sets the step between each contour level. Must be positive.",
- "dflt": null,
- "editType": "calc",
+ "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",
- "magic_underscores": "fig.update_traces(contours_z_size=<VALUE>, selector=dict(type='surface'))"
- },
- "start": {
- "description": "Sets the starting contour level value. Must be less than `contours.end`",
- "dflt": null,
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(contours_z_start=<VALUE>, selector=dict(type='surface'))"
- },
- "usecolormap": {
- "description": "An alternate to *color*. Determines whether or not the contour lines are colored using the trace *colorscale*.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contours_z_usecolormap=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='funnelarea'))"
},
- "width": {
- "description": "Sets the width of the contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
+ "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",
- "magic_underscores": "fig.update_traces(contours_z_width=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(contours_z=dict(...), selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(contours=dict(...), selector=dict(type='surface'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='funnelarea'))"
},
- "hidesurface": {
- "description": "Determines whether or not a surface is drawn. For example, set `hidesurface` to *false* `contours.x.show` to *true* and `contours.y.show` to *true* to draw a wire frame plot.",
- "dflt": false,
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='funnelarea'))"
+ },
+ "textinfo": {
+ "description": "Determines what trace information appears on the graph. Flags are rendered in a fixed order; use `texttemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hidesurface=<VALUE>, selector=dict(type='surface'))"
+ "extras": [
+ "none"
+ ],
+ "flags": [
+ "label",
+ "text",
+ "value",
+ "percent"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(textinfo=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "aspectratio": {
+ "description": "Sets the ratio between height and width",
+ "dflt": 1,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(aspectratio=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "baseratio": {
+ "description": "Sets the ratio between bottom length and maximum top length.",
+ "dflt": 0.333,
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(baseratio=<VALUE>, selector=dict(type='funnelarea'))"
},
"hoverlabel": {
"align": {
@@ -55963,36 +46673,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='surface'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='funnelarea'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='surface'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='funnelarea'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='surface'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='funnelarea'))"
},
"editType": "none",
"font": {
@@ -56000,12 +46695,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='surface'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='funnelarea'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -56016,12 +46706,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='surface'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='funnelarea'))"
},
"lineposition": {
"arrayOk": true,
@@ -56037,12 +46722,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='surface'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
},
"role": "object",
"shadow": {
@@ -56051,24 +46731,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='surface'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='funnelarea'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='surface'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='funnelarea'))"
},
"style": {
"arrayOk": true,
@@ -56080,12 +46750,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='surface'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='funnelarea'))"
},
"textcase": {
"arrayOk": true,
@@ -56099,12 +46764,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='surface'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='funnelarea'))"
},
"variant": {
"arrayOk": true,
@@ -56120,12 +46780,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='surface'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='funnelarea'))"
},
"weight": {
"arrayOk": true,
@@ -56139,14 +46794,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='surface'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='funnelarea'))"
},
"namelength": {
"arrayOk": true,
@@ -56155,12 +46805,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='surface'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='funnelarea'))"
},
"role": "object",
"showarrow": {
@@ -56168,291 +46813,211 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='funnelarea'))"
},
- "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",
- "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='surface'))"
+ "insidetextfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "plot",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='funnelarea'))"
},
- "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",
- "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='surface'))"
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='funnelarea'))"
},
- "editType": "calc",
- "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",
- "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='surface'))"
+ "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",
+ "magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='funnelarea'))"
},
"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",
- "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='surface'))"
+ "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",
+ "magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='funnelarea'))"
},
- "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,
+ "size": {
+ "arrayOk": true,
+ "editType": "plot",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='surface'))"
- },
- "lightposition": {
- "editType": "calc",
- "role": "object",
- "x": {
- "description": "Numeric vector, representing the X coordinate for each vertex.",
- "dflt": 10,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='surface'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='funnelarea'))"
},
- "y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 10000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='surface'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='funnelarea'))"
},
- "z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='surface'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='surface'))"
- },
- "opacityscale": {
- "description": "Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.",
- "editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(opacityscale=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='surface'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='surface'))"
+ "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",
+ "magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='funnelarea'))"
+ },
+ "magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='funnelarea'))"
},
- "zcalendar": {
- "description": "Sets the calendar system to use with `z` date data.",
- "dflt": "gregorian",
+ "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": "enumerated",
- "values": [
- "chinese",
- "coptic",
- "discworld",
- "ethiopian",
- "gregorian",
- "hebrew",
- "islamic",
- "jalali",
- "julian",
- "mayan",
- "nanakshahi",
- "nepali",
- "persian",
- "taiwan",
- "thai",
- "ummalqura"
- ],
- "magic_underscores": "fig.update_traces(zcalendar=<VALUE>, selector=dict(type='surface'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(scalegroup=<VALUE>, selector=dict(type='funnelarea'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='surface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='surface'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='funnelarea'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='surface'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='funnelarea'))"
},
"categories": [
- "gl3d",
- "2dMap",
+ "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"
+ }
+ },
"meta": {
- "description": "The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a {2D array}. Coordinates in `x` and `y` can either be 1D {arrays} or {2D arrays} (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the `z` values by default. For custom color scales, use `surfacecolor` which should be a {2D array}, where its bounds can be controlled using `cmin` and `cmax`."
+ "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": "surface"
+ "type": "funnelarea"
},
- "mesh3d": {
- "animatable": false,
+ "indicator": {
+ "animatable": true,
"attributes": {
- "type": "mesh3d",
+ "type": "indicator",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='indicator'))"
},
- "legendgrouptitle": {
- "editType": "style",
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(title_align=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "editType": "plot",
"font": {
"color": {
- "editType": "style",
+ "editType": "plot",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_color=<VALUE>, selector=dict(type='indicator'))"
},
- "description": "Sets this legend group's title font.",
- "editType": "style",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_family=<VALUE>, selector=dict(type='indicator'))"
},
"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"
],
@@ -56462,37 +47027,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_lineposition=<VALUE>, selector=dict(type='indicator'))"
},
"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",
+ "editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_shadow=<VALUE>, selector=dict(type='indicator'))"
},
"size": {
- "editType": "style",
+ "editType": "plot",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_size=<VALUE>, selector=dict(type='indicator'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_style=<VALUE>, selector=dict(type='indicator'))"
},
"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",
@@ -56500,12 +47065,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_textcase=<VALUE>, selector=dict(type='indicator'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -56515,12 +47080,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_variant=<VALUE>, selector=dict(type='indicator'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "style",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -56528,521 +47093,323 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font_weight=<VALUE>, selector=dict(type='indicator'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_font=dict(...), selector=dict(type='indicator'))"
},
"role": "object",
"text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
+ "description": "Sets the title of this indicator.",
+ "editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(title_text=<VALUE>, selector=dict(type='indicator'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='mesh3d'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "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",
- "magic_underscores": "fig.update_traces(i=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(j=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(k=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "ksrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `k`.",
- "editType": "none",
- "valType": "string"
- },
- "facecolor": {
- "description": "Sets the color of each face Overrides *color* and *vertexcolor*.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(facecolor=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "facecolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `facecolor`.",
- "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",
- "magic_underscores": "fig.update_traces(intensity=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "intensitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `intensity`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(title=dict(...), selector=dict(type='indicator'))"
},
- "intensitymode": {
- "description": "Determines the source of `intensity` values.",
- "dflt": "vertex",
+ "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": [
- "vertex",
- "cell"
+ true,
+ false,
+ "legendonly"
],
- "magic_underscores": "fig.update_traces(intensitymode=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(vertexcolor=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "vertexcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `vertexcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='indicator'))"
},
- "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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='mesh3d'))"
+ "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",
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='indicator'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "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",
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='indicator'))"
},
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='mesh3d'))"
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
+ "color": {
+ "editType": "style",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "size": {
+ "editType": "style",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "style",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='indicator'))"
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='indicator'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='indicator'))"
},
- "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",
+ "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",
- "extras": [
- "all",
- "none",
- "skip"
- ],
"flags": [
- "x",
- "y",
- "z",
- "text",
- "name"
+ "number",
+ "delta",
+ "gauge"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='indicator'))"
},
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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": "",
+ "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": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='mesh3d'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='indicator'))"
},
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
+ "value": {
+ "anim": true,
+ "description": "Sets the number to be displayed.",
"editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='mesh3d'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(value=<VALUE>, selector=dict(type='indicator'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='indicator'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "color": {
- "description": "Sets the color of the whole mesh",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(color=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='indicator'))"
},
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "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": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='mesh3d'))"
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(domain_column=<VALUE>, selector=dict(type='indicator'))"
},
- "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*.",
+ "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": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(domain_row=<VALUE>, selector=dict(type='indicator'))"
},
- "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"
+ "x": {
+ "description": "Sets the horizontal domain of this indicator trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='mesh3d'))"
+ "valType": "info_array",
+ "magic_underscores": "fig.update_traces(domain_x=list(...), selector=dict(type='indicator'))"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
+ "y": {
+ "description": "Sets the vertical domain of this indicator trace (in plot fraction).",
+ "dflt": [
+ 0,
+ 1
],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
+ "editType": "calc",
+ "items": [
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ },
+ {
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number"
+ }
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='mesh3d'))"
+ "valType": "info_array",
+ "magic_underscores": "fig.update_traces(domain_y=list(...), selector=dict(type='indicator'))"
},
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(domain=dict(...), selector=dict(type='indicator'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(align=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "delta": {
+ "decreasing": {
+ "color": {
+ "description": "Sets the color for increasing value.",
+ "dflt": "#FF4136",
+ "editType": "plot",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(delta_decreasing_color=<VALUE>, selector=dict(type='indicator'))"
},
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='mesh3d'))"
+ "editType": "plot",
+ "role": "object",
+ "symbol": {
+ "description": "Sets the symbol to display for increasing value",
+ "dflt": "\u25bc",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(delta_decreasing_symbol=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(delta_decreasing=dict(...), selector=dict(type='indicator'))"
},
- "tickfont": {
+ "editType": "calc",
+ "font": {
"color": {
- "editType": "colorbars",
+ "editType": "plot",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_color=<VALUE>, selector=dict(type='indicator'))"
},
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_family=<VALUE>, selector=dict(type='indicator'))"
},
"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"
],
@@ -57052,37 +47419,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_lineposition=<VALUE>, selector=dict(type='indicator'))"
},
"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": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_shadow=<VALUE>, selector=dict(type='indicator'))"
},
"size": {
- "editType": "colorbars",
+ "editType": "plot",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_size=<VALUE>, selector=dict(type='indicator'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_style=<VALUE>, selector=dict(type='indicator'))"
},
"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",
@@ -57090,12 +47457,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_textcase=<VALUE>, selector=dict(type='indicator'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -57105,12 +47472,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_variant=<VALUE>, selector=dict(type='indicator'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -57118,590 +47485,100 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font_weight=<VALUE>, selector=dict(type='indicator'))"
},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- ""
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_font=dict(...), selector=dict(type='indicator'))"
},
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='mesh3d'))"
- },
- "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*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='mesh3d'))"
+ "increasing": {
+ "color": {
+ "description": "Sets the color for increasing value.",
+ "dflt": "#3D9970",
+ "editType": "plot",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(delta_increasing_color=<VALUE>, selector=dict(type='indicator'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='mesh3d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(alphahull=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(delaunayaxis=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "contour": {
- "color": {
- "description": "Sets the color of the contour lines.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(contour_color=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "editType": "calc",
- "role": "object",
- "show": {
- "description": "Sets whether or not dynamic contours are shown on hover",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contour_show=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "width": {
- "description": "Sets the width of the contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contour_width=<VALUE>, selector=dict(type='mesh3d'))"
+ "editType": "plot",
+ "role": "object",
+ "symbol": {
+ "description": "Sets the symbol to display for increasing value",
+ "dflt": "\u25b2",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(delta_increasing_symbol=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(delta_increasing=dict(...), selector=dict(type='indicator'))"
},
- "magic_underscores": "fig.update_traces(contour=dict(...), selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(flatshading=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
+ "position": {
+ "description": "Sets the position of delta with respect to the number.",
+ "dflt": "bottom",
+ "editType": "plot",
"valType": "enumerated",
"values": [
+ "top",
+ "bottom",
"left",
- "right",
- "auto"
+ "right"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(delta_position=<VALUE>, selector=dict(type='indicator'))"
},
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "prefix": {
+ "description": "Sets a prefix appearing before the delta.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(delta_prefix=<VALUE>, selector=dict(type='indicator'))"
},
- "bgcolor": {
- "arrayOk": true,
- "description": "Sets the background color of the hover labels for this trace",
- "editType": "none",
- "valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='mesh3d'))"
+ "reference": {
+ "description": "Sets the reference value to compute the delta. By default, it is set to the current value.",
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(delta_reference=<VALUE>, selector=dict(type='indicator'))"
},
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "relative": {
+ "description": "Show relative change",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(delta_relative=<VALUE>, selector=dict(type='indicator'))"
},
- "bordercolor": {
- "arrayOk": true,
- "description": "Sets the border color of the hover labels for this trace.",
- "editType": "none",
- "valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='mesh3d'))"
+ "role": "object",
+ "suffix": {
+ "description": "Sets a suffix appearing next to the delta.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(delta_suffix=<VALUE>, selector=dict(type='indicator'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "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",
+ "magic_underscores": "fig.update_traces(delta_valueformat=<VALUE>, selector=dict(type='indicator'))"
},
- "editType": "none",
+ "magic_underscores": "fig.update_traces(delta=dict(...), selector=dict(type='indicator'))"
+ },
+ "number": {
+ "editType": "plot",
"font": {
"color": {
- "arrayOk": true,
- "editType": "none",
+ "editType": "plot",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_color=<VALUE>, selector=dict(type='indicator'))"
},
- "description": "Sets the font used in hover labels.",
- "editType": "none",
+ "description": "Set the font used to display main number",
+ "editType": "plot",
"family": {
- "arrayOk": true,
"description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "none",
+ "editType": "plot",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_family=<VALUE>, selector=dict(type='indicator'))"
},
"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"
],
@@ -57711,61 +47588,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_lineposition=<VALUE>, selector=dict(type='indicator'))"
},
"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",
+ "editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_shadow=<VALUE>, selector=dict(type='indicator'))"
},
"size": {
- "arrayOk": true,
- "editType": "none",
+ "editType": "plot",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_size=<VALUE>, selector=dict(type='indicator'))"
},
"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"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_style=<VALUE>, selector=dict(type='indicator'))"
},
"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",
@@ -57773,18 +47626,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_textcase=<VALUE>, selector=dict(type='indicator'))"
},
"variant": {
- "arrayOk": true,
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"valType": "enumerated",
"values": [
"normal",
@@ -57794,18 +47641,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_variant=<VALUE>, selector=dict(type='indicator'))"
},
"weight": {
- "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "none",
+ "editType": "plot",
"extras": [
"normal",
"bold"
@@ -57813,896 +47654,699 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(number_font_weight=<VALUE>, selector=dict(type='indicator'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "editType": "calc",
- "facenormalsepsilon": {
- "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 1e-06,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(number_font=dict(...), selector=dict(type='indicator'))"
},
- "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",
- "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='mesh3d'))"
+ "prefix": {
+ "description": "Sets a prefix appearing before the number.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(number_prefix=<VALUE>, selector=dict(type='indicator'))"
},
- "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(zcalendar=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='mesh3d'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='mesh3d'))"
+ "suffix": {
+ "description": "Sets a suffix appearing next to the number.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(number_suffix=<VALUE>, selector=dict(type='indicator'))"
},
- "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,
+ "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='mesh3d'))"
+ "magic_underscores": "fig.update_traces(number_valueformat=<VALUE>, selector=dict(type='indicator'))"
},
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='mesh3d'))"
- },
- "magic_underscores": "fig.update_traces(..., selector=dict(type='mesh3d'))"
- },
- "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"
- },
- "cone": {
- "animatable": false,
- "attributes": {
- "type": "cone",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='cone'))"
- },
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='cone'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(number=dict(...), selector=dict(type='indicator'))"
},
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='cone'))"
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_dtick_impliedEdits=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(gauge_axis_dtick=<VALUE>, selector=dict(type='indicator'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='cone'))"
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "plot",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
+ ],
+ "magic_underscores": "fig.update_traces(gauge_axis_exponentformat=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(gauge_axis_labelalias=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_minexponent=<VALUE>, selector=dict(type='indicator'))"
},
- "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"
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_nticks=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "range": {
+ "description": "Sets the range of this axis.",
+ "editType": "plot",
+ "items": [
+ {
+ "editType": "plot",
+ "valType": "number"
+ },
+ {
+ "editType": "plot",
+ "valType": "number"
+ }
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='cone'))"
+ "valType": "info_array",
+ "magic_underscores": "fig.update_traces(gauge_axis_range=list(...), selector=dict(type='indicator'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='cone'))"
- },
- "size": {
- "editType": "style",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='cone'))"
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "plot",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(gauge_axis_separatethousands=<VALUE>, selector=dict(type='indicator'))"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
+ "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": [
- "normal",
- "italic"
+ "all",
+ "first",
+ "last",
+ "none"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(gauge_axis_showexponent=<VALUE>, selector=dict(type='indicator'))"
},
- "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",
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "plot",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(gauge_axis_showticklabels=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "all",
+ "first",
+ "last",
+ "none"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(gauge_axis_showtickprefix=<VALUE>, selector=dict(type='indicator'))"
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "all",
+ "first",
+ "last",
+ "none"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(gauge_axis_showticksuffix=<VALUE>, selector=dict(type='indicator'))"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='cone'))"
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_tick0_impliedEdits=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(gauge_axis_tick0=<VALUE>, selector=dict(type='indicator'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='cone'))"
- },
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='cone'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='cone'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='cone'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "z": {
- "description": "Sets the z coordinates of the vector field and of the displayed cones.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='cone'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
- "u": {
- "description": "Sets the x components of the vector field.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(u=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(v=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(w=<VALUE>, selector=dict(type='cone'))"
- },
- "wsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `w`.",
- "editType": "none",
- "valType": "string"
- },
- "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.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='cone'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "hovertext": {
- "arrayOk": true,
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='cone'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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": "x+y+z+norm+text+name",
- "editType": "calc",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "u",
- "v",
- "w",
- "norm",
- "text",
- "name"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='cone'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='cone'))"
- },
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='cone'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uhoverformat=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(vhoverformat=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(whoverformat=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='cone'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='cone'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='cone'))"
- },
- "colorbar": {
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickangle=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickcolor=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "plot",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_color=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "plot",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_family=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_lineposition=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_shadow=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "size": {
+ "editType": "plot",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_size=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_style=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_textcase=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_variant=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "plot",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont_weight=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(gauge_axis_tickfont=dict(...), selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickformat=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickformatstops=list(...), selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_ticklabelstep=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(gauge_axis_ticklen=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(gauge_axis_tickmode_impliedEdits=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ],
+ "magic_underscores": "fig.update_traces(gauge_axis_tickmode=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickprefix=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ ""
+ ],
+ "magic_underscores": "fig.update_traces(gauge_axis_ticks=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(gauge_axis_ticksuffix=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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": "plot",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(gauge_axis_ticktext=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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": "plot",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickvals=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(gauge_axis_tickwidth=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_axis_visible=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(gauge_axis=dict(...), selector=dict(type='indicator'))"
+ },
+ "bar": {
+ "color": {
+ "description": "Sets the background color of the arc.",
+ "dflt": "green",
+ "editType": "plot",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(gauge_bar_color=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_bar_line_color=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_bar_line_width=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(gauge_bar_line=dict(...), selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_bar_thickness=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(gauge_bar=dict(...), selector=dict(type='indicator'))"
+ },
"bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
+ "description": "Sets the gauge background color.",
+ "editType": "plot",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(gauge_bgcolor=<VALUE>, selector=dict(type='indicator'))"
},
"bordercolor": {
- "description": "Sets the axis line color.",
+ "description": "Sets the color of the border enclosing the gauge.",
"dflt": "#444",
- "editType": "colorbars",
+ "editType": "plot",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(gauge_bordercolor=<VALUE>, selector=dict(type='indicator'))"
},
"borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='cone'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='cone'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='cone'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='cone'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='cone'))"
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='cone'))"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
+ "description": "Sets the width (in px) of the border enclosing the gauge.",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "plot",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(gauge_borderwidth=<VALUE>, selector=dict(type='indicator'))"
},
+ "description": "The gauge of the Indicator plot.",
+ "editType": "plot",
"role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='cone'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='cone'))"
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
+ "shape": {
+ "description": "Set the shape of the gauge",
+ "dflt": "angular",
+ "editType": "plot",
"valType": "enumerated",
"values": [
- "fraction",
- "pixels"
+ "angular",
+ "bullet"
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(gauge_shape=<VALUE>, selector=dict(type='indicator'))"
},
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ "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"
+ }
+ }
},
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='cone'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(gauge_steps=list(...), selector=dict(type='indicator'))"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='cone'))"
+ "threshold": {
+ "editType": "plot",
+ "line": {
+ "color": {
+ "description": "Sets the color of the threshold line.",
+ "dflt": "#444",
+ "editType": "plot",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(gauge_threshold_line_color=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "editType": "plot",
+ "role": "object",
+ "width": {
+ "description": "Sets the width (in px) of the threshold line.",
+ "dflt": 1,
+ "editType": "plot",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(gauge_threshold_line_width=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(gauge_threshold_line=dict(...), selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(gauge_threshold_thickness=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "value": {
+ "description": "Sets a treshold value drawn as a line.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(gauge_threshold_value=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(gauge_threshold=dict(...), selector=dict(type='indicator'))"
},
- "tickfont": {
+ "magic_underscores": "fig.update_traces(gauge=dict(...), selector=dict(type='indicator'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='indicator'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='indicator'))"
+ },
+ "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"
+ },
+ "scatter3d": {
+ "animatable": false,
+ "attributes": {
+ "type": "scatter3d",
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": true,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
"color": {
- "editType": "colorbars",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='scatter3d'))"
},
- "description": "Sets the color bar's tick label font",
- "editType": "colorbars",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
+ "editType": "style",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='scatter3d'))"
},
"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": "style",
"extras": [
"none"
],
@@ -58712,37 +48356,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
},
"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": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='scatter3d'))"
},
"size": {
- "editType": "colorbars",
+ "editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='scatter3d'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='scatter3d'))"
},
"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": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -58750,12 +48394,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='scatter3d'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "style",
"valType": "enumerated",
"values": [
"normal",
@@ -58765,215 +48409,516 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='scatter3d'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "style",
"extras": [
"normal",
"bold"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='cone'))"
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "role": "object",
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "x": {
+ "description": "Sets the x coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "y": {
+ "description": "Sets the y coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "z": {
+ "description": "Sets the z coordinates.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "surfacecolor": {
+ "description": "Sets the surface fill color.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(surfacecolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "texttemplate": {
+ "arrayOk": true,
+ "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. ",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "texttemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "calc",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines what trace information appears on hover. 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",
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "hovertemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "calc",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- }
- }
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='scatter3d'))"
},
- "role": "object",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='cone'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='cone'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='scatter3d'))"
},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='cone'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- ""
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='cone'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='cone'))"
- },
- "title": {
- "editType": "colorbars",
- "font": {
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "tickfont": {
"color": {
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='scatter3d'))"
},
- "description": "Sets this color bar's title font.",
- "editType": "colorbars",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
+ "editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='scatter3d'))"
},
"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"
],
@@ -58983,37 +48928,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scatter3d'))"
},
"size": {
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='scatter3d'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='scatter3d'))"
},
"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",
@@ -59021,12 +48966,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scatter3d'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -59036,12 +48981,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scatter3d'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"normal",
"bold"
@@ -59049,1739 +48994,1708 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='cone'))"
- },
- "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*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='cone'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='cone'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='cone'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='cone'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='cone'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='cone'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='cone'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='cone'))"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='cone'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='cone'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='cone'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='cone'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='cone'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='cone'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='cone'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='cone'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(anchor=<VALUE>, selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='cone'))"
- },
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "none",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='scatter3d'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "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": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='scatter3d'))"
},
- "size": {
- "arrayOk": true,
- "editType": "none",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='cone'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='scatter3d'))"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "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": "calc",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scatter3d'))"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "none",
+ "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": [
- "normal",
- "italic"
+ "outside",
+ "inside",
+ "outside top",
+ "inside top",
+ "outside left",
+ "inside left",
+ "outside right",
+ "inside right",
+ "outside bottom",
+ "inside bottom"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scatter3d'))"
},
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "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,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
"valType": "enumerated",
"values": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "auto",
+ "linear",
+ "array"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='scatter3d'))"
},
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='scatter3d'))"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "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": "calc",
"valType": "enumerated",
"values": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "outside",
+ "inside",
+ ""
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='cone'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='scatter3d'))"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='cone'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scatter3d'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='cone'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='cone'))"
- },
- "editType": "calc",
- "facenormalsepsilon": {
- "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 1e-06,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='cone'))"
- },
- "y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='cone'))"
- },
- "z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='cone'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(sizemode=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(sizeref=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='cone'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='cone'))"
- },
- "magic_underscores": "fig.update_traces(..., selector=dict(type='cone'))"
- },
- "categories": [
- "gl3d",
- "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`."
- },
- "type": "cone"
- },
- "streamtube": {
- "animatable": false,
- "attributes": {
- "type": "streamtube",
- "name": {
- "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='streamtube'))"
- },
- "uid": {
- "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
- "editType": "plot",
- "valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='streamtube'))"
- },
- "showlegend": {
- "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": false,
- "editType": "style",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='streamtube'))"
- },
- "legendgrouptitle": {
- "editType": "style",
- "font": {
- "color": {
- "editType": "style",
- "valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='streamtube'))"
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='scatter3d'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "style",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='streamtube'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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"
+ "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"
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='scatter3d'))"
},
- "size": {
- "editType": "style",
- "min": 1,
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='scatter3d'))"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "style",
+ "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": [
- "normal",
- "italic"
+ "container",
+ "paper"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "top",
+ "middle",
+ "bottom"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='scatter3d'))"
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "style",
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
- ],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='streamtube'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "style",
- "extras": [
- "normal",
- "bold"
+ "container",
+ "paper"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scatter3d'))"
},
- "role": "object",
- "text": {
- "description": "Sets the title of the legend group.",
- "dflt": "",
- "editType": "style",
- "valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='streamtube'))"
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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,
+ "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='streamtube'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='streamtube'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "x": {
- "description": "Sets the x coordinates of the vector field.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='streamtube'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "z": {
- "description": "Sets the z coordinates of the vector field.",
- "editType": "calc+clearAxisTypes",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='streamtube'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
- "u": {
- "description": "Sets the x components of the vector field.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(u=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(v=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(w=<VALUE>, selector=dict(type='streamtube'))"
- },
- "wsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `w`.",
- "editType": "none",
- "valType": "string"
- },
- "text": {
- "description": "Sets a text element associated with this trace. If trace `hoverinfo` contains a *text* flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array `text` values.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='streamtube'))"
- },
- "hovertext": {
- "description": "Same as `text`.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "editType": "calc",
- "extras": [
- "all",
- "none",
- "skip"
- ],
- "flags": [
- "x",
- "y",
- "z",
- "u",
- "v",
- "w",
- "norm",
- "divergence",
- "text",
- "name"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='streamtube'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
- "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='streamtube'))"
- },
- "hovertemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='streamtube'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uhoverformat=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(vhoverformat=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(whoverformat=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='streamtube'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='streamtube'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='streamtube'))"
- },
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='streamtube'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='streamtube'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_line_autocolorscale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_cauto_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_line_cauto=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_line_cmax_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmax=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_cmid_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmid=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_line_cmin_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmin=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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,
+ "magic_underscores": "fig.update_traces(marker_line_colorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_reversescale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "role": "object",
+ "width": {
+ "arrayOk": false,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scatter3d'))"
},
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scatter3d'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='streamtube'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the marker size (in px).",
+ "dflt": 8,
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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*.",
+ "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": "colorbars",
+ "editType": "calc",
"min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='streamtube'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_sizemin=<VALUE>, selector=dict(type='scatter3d'))"
},
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
+ "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": [
- "h",
- "v"
+ "diameter",
+ "area"
],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='streamtube'))"
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_sizemode=<VALUE>, selector=dict(type='scatter3d'))"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
+ "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": "colorbars",
- "min": 0,
+ "editType": "calc",
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='streamtube'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "symbol": {
+ "arrayOk": true,
+ "description": "Sets the marker symbol type.",
+ "dflt": "circle",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "circle",
+ "circle-open",
+ "cross",
+ "diamond",
+ "diamond-open",
+ "square",
+ "square-open",
+ "x"
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scatter3d'))"
},
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "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": "colorbars",
+ "editType": "calc",
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_autocolorscale=<VALUE>, selector=dict(type='scatter3d'))"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='streamtube'))"
+ "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": {
+ "magic_underscores": "fig.update_traces(line_cauto_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(line_cauto=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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,
+ "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,
+ "magic_underscores": "fig.update_traces(line_cmax_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_cmax=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "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": {
- "tickmode": "linear",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_cmid_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
},
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='streamtube'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_cmid=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='streamtube'))"
+ "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,
+ "magic_underscores": "fig.update_traces(line_cmin_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_cmin=<VALUE>, selector=dict(type='scatter3d'))"
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
+ "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",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='scatter3d'))"
},
- "tickfont": {
- "color": {
- "editType": "colorbars",
+ "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",
+ "magic_underscores": "fig.update_traces(line_coloraxis=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_bgcolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(line_colorbar_bordercolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_colorbar_borderwidth=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(line_colorbar_dtick=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_exponentformat=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(line_colorbar_labelalias=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_len=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_lenmode=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_minexponent=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_nticks=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_orientation=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(line_colorbar_outlinecolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_colorbar_outlinewidth=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(line_colorbar_separatethousands=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_showexponent=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(line_colorbar_showticklabels=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_showtickprefix=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_showticksuffix=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_thickness=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_thicknessmode=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(line_colorbar_tick0=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickangle=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickcolor=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_color=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_family=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_size=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_style=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(line_colorbar_tickfont=dict(...), selector=dict(type='scatter3d'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
+ "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",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_tickformat=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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"
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickformatstops=list(...), selector=dict(type='scatter3d'))"
+ },
+ "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"
],
- "flags": [
- "under",
- "over",
- "through"
+ "magic_underscores": "fig.update_traces(line_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_colorbar_ticklen=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(line_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_tickmode=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_tickprefix=<VALUE>, selector=dict(type='scatter3d'))"
},
- "size": {
- "editType": "colorbars",
- "min": 1,
+ "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",
+ ""
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_ticks=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(line_colorbar_ticksuffix=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_ticktext=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_tickvals=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_tickwidth=<VALUE>, selector=dict(type='scatter3d'))"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_color=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_family=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_size=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_style=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_variant=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font_weight=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(line_colorbar_title_font=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(line_colorbar_title_side=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(line_colorbar_title_text=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(line_colorbar_title=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_x=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
- "italic"
+ "left",
+ "center",
+ "right"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_xanchor=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_colorbar_xpad=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "container",
+ "paper"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_xref=<VALUE>, selector=dict(type='scatter3d'))"
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
+ "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",
+ "magic_underscores": "fig.update_traces(line_colorbar_y=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "top",
+ "middle",
+ "bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_yanchor=<VALUE>, selector=dict(type='scatter3d'))"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_colorbar_ypad=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar_yref=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(line_colorbar=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
+ "magic_underscores": "fig.update_traces(line_colorscale_impliedEdits=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(line_colorscale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "dash": {
+ "description": "Sets the dash style of the lines.",
+ "dflt": "solid",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "dash",
+ "dashdot",
+ "dot",
+ "longdash",
+ "longdashdot",
+ "solid"
+ ],
+ "magic_underscores": "fig.update_traces(line_dash=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(line_reversescale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(line_showscale=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "textfont": {
+ "color": {
+ "arrayOk": true,
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='streamtube'))"
+ "role": "object",
+ "size": {
+ "arrayOk": true,
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "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": [
- "allow",
- "hide past div",
- "hide past domain"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "variant": {
+ "arrayOk": true,
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "calc",
"valType": "enumerated",
"values": [
- "outside",
- "inside",
- "outside top",
- "inside top",
- "outside left",
- "inside left",
- "outside right",
- "inside right",
- "outside bottom",
- "inside bottom"
+ "normal",
+ "small-caps"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scatter3d'))"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "error_x": {
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_array=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_arrayminus=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "color": {
+ "description": "Sets the stroke color of the error bars.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(error_x_color=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "copy_zstyle": {
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(error_x_copy_zstyle=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_symmetric=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_x_thickness=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
- },
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='streamtube'))"
+ "traceref": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_x_traceref=<VALUE>, selector=dict(type='scatter3d'))"
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='streamtube'))"
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_x_tracerefminus=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "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": [
- "outside",
- "inside",
- ""
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_x_type=<VALUE>, selector=dict(type='scatter3d'))"
},
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='streamtube'))"
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_value=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='streamtube'))"
+ "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",
+ "magic_underscores": "fig.update_traces(error_x_valueminus=<VALUE>, selector=dict(type='scatter3d'))"
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(error_x_visible=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(error_x_width=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(error_x=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "error_y": {
+ "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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_y_array=<VALUE>, selector=dict(type='scatter3d'))"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(error_y_arrayminus=<VALUE>, selector=dict(type='scatter3d'))"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
+ "color": {
+ "description": "Sets the stroke color of the error bars.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(error_y_color=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "copy_zstyle": {
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(error_y_copy_zstyle=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_y_symmetric=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_y_thickness=<VALUE>, selector=dict(type='scatter3d'))"
},
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='streamtube'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='streamtube'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='streamtube'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='streamtube'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='streamtube'))"
- },
- "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*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='streamtube'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='streamtube'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='streamtube'))"
+ "traceref": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_y_traceref=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_y_tracerefminus=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(error_y_type=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_y_value=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_y_valueminus=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(error_y_visible=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(error_y_width=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(error_y=dict(...), selector=dict(type='scatter3d'))"
+ },
+ "error_z": {
+ "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",
+ "magic_underscores": "fig.update_traces(error_z_array=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(error_z_arrayminus=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "color": {
+ "description": "Sets the stroke color of the error bars.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(error_z_color=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='streamtube'))"
+ "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",
+ "magic_underscores": "fig.update_traces(error_z_symmetric=<VALUE>, selector=dict(type='scatter3d'))"
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
+ "thickness": {
+ "description": "Sets the thickness (in px) of the error bars.",
+ "dflt": 2,
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_z_thickness=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='streamtube'))"
+ "traceref": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_z_traceref=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='streamtube'))"
+ "tracerefminus": {
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(error_z_tracerefminus=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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",
+ "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": [
- "top",
- "middle",
- "bottom"
+ "percent",
+ "constant",
+ "sqrt",
+ "data"
],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_z_type=<VALUE>, selector=dict(type='scatter3d'))"
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
+ "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": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_z_value=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='streamtube'))"
+ "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",
+ "magic_underscores": "fig.update_traces(error_z_valueminus=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='streamtube'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ "visible": {
+ "description": "Determines whether or not this set of error bars is visible.",
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(error_z_visible=<VALUE>, selector=dict(type='scatter3d'))"
},
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ "width": {
+ "description": "Sets the width (in px) of the cross-bar at both ends of the error bars.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(error_z_width=<VALUE>, selector=dict(type='scatter3d'))"
},
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='streamtube'))"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(error_z=dict(...), selector=dict(type='scatter3d'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
+ "editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='scatter3d'))"
},
- "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,
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
+ "dflt": false,
"editType": "calc",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
- },
"valType": "boolean",
- "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='scatter3d'))"
},
"hoverlabel": {
"align": {
@@ -60795,36 +50709,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='streamtube'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scatter3d'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='streamtube'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scatter3d'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='streamtube'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scatter3d'))"
},
"editType": "none",
"font": {
@@ -60832,12 +50731,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='streamtube'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scatter3d'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -60848,12 +50742,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='streamtube'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scatter3d'))"
},
"lineposition": {
"arrayOk": true,
@@ -60869,12 +50758,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='streamtube'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scatter3d'))"
},
"role": "object",
"shadow": {
@@ -60883,24 +50767,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='streamtube'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scatter3d'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='streamtube'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scatter3d'))"
},
"style": {
"arrayOk": true,
@@ -60912,12 +50786,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='streamtube'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scatter3d'))"
},
"textcase": {
"arrayOk": true,
@@ -60931,12 +50800,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='streamtube'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scatter3d'))"
},
"variant": {
"arrayOk": true,
@@ -60952,12 +50816,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='streamtube'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scatter3d'))"
},
"weight": {
"arrayOk": true,
@@ -60971,14 +50830,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='streamtube'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scatter3d'))"
},
"namelength": {
"arrayOk": true,
@@ -60987,12 +50841,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='streamtube'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scatter3d'))"
},
"role": "object",
"showarrow": {
@@ -61000,218 +50849,228 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='streamtube'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='streamtube'))"
- },
- "editType": "calc",
- "facenormalsepsilon": {
- "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
- "dflt": 1e-06,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='scatter3d'))"
},
- "lightposition": {
+ "projection": {
"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",
- "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='streamtube'))"
+ "opacity": {
+ "description": "Sets the projection color.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(projection_x_opacity=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(projection_x_scale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "show": {
+ "description": "Sets whether or not projections are shown along the x axis.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(projection_x_show=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(projection_x=dict(...), selector=dict(type='scatter3d'))"
},
"y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 100000,
"editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='streamtube'))"
+ "opacity": {
+ "description": "Sets the projection color.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(projection_y_opacity=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(projection_y_scale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "show": {
+ "description": "Sets whether or not projections are shown along the y axis.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(projection_y_show=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(projection_y=dict(...), selector=dict(type='scatter3d'))"
},
"z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
"editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='streamtube'))"
+ "opacity": {
+ "description": "Sets the projection color.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(projection_z_opacity=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(projection_z_scale=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "show": {
+ "description": "Sets whether or not projections are shown along the z axis.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(projection_z_show=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "magic_underscores": "fig.update_traces(projection_z=dict(...), selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(projection=dict(...), selector=dict(type='scatter3d'))"
},
- "maxdisplayed": {
- "description": "The maximum number of displayed segments in a streamtube.",
- "dflt": 1000,
+ "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",
- "min": 0,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(maxdisplayed=<VALUE>, selector=dict(type='streamtube'))"
+ "valType": "enumerated",
+ "values": [
+ -1,
+ 0,
+ 1,
+ 2
+ ],
+ "magic_underscores": "fig.update_traces(surfaceaxis=<VALUE>, selector=dict(type='scatter3d'))"
},
- "sizeref": {
- "description": "The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.",
- "dflt": 1,
+ "xcalendar": {
+ "description": "Sets the calendar system to use with `x` date data.",
+ "dflt": "gregorian",
"editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(sizeref=<VALUE>, selector=dict(type='streamtube'))"
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ],
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='scatter3d'))"
},
- "starts": {
+ "ycalendar": {
+ "description": "Sets the calendar system to use with `y` date data.",
+ "dflt": "gregorian",
"editType": "calc",
- "role": "object",
- "x": {
- "description": "Sets the x components of the starting position of the streamtubes",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(starts_x=<VALUE>, selector=dict(type='streamtube'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
- "y": {
- "description": "Sets the y components of the starting position of the streamtubes",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(starts_y=<VALUE>, selector=dict(type='streamtube'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
- "z": {
- "description": "Sets the z components of the starting position of the streamtubes",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(starts_z=<VALUE>, selector=dict(type='streamtube'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(starts=dict(...), selector=dict(type='streamtube'))"
+ "valType": "enumerated",
+ "values": [
+ "chinese",
+ "coptic",
+ "discworld",
+ "ethiopian",
+ "gregorian",
+ "hebrew",
+ "islamic",
+ "jalali",
+ "julian",
+ "mayan",
+ "nanakshahi",
+ "nepali",
+ "persian",
+ "taiwan",
+ "thai",
+ "ummalqura"
+ ],
+ "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='scatter3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(zcalendar=<VALUE>, selector=dict(type='scatter3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='streamtube'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='streamtube'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scatter3d'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='streamtube'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='scatter3d'))"
},
"categories": [
"gl3d",
- "showLegend"
+ "symbols",
+ "showLegend",
+ "scatter-like"
],
"meta": {
- "description": "Use a streamtube trace to visualize flow in a vector field. Specify a vector field using 6 1D arrays of equal length, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, and `w`. By default, the tubes' starting positions will be cut from the vector field's x-z plane at its minimum y value. To specify your own starting position, use attributes `starts.x`, `starts.y` and `starts.z`. The color is encoded by the norm of (u, v, w), and the local radius by the divergence of (u, v, w)."
+ "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": "streamtube"
+ "type": "scatter3d"
},
- "volume": {
+ "surface": {
"animatable": false,
"attributes": {
- "type": "volume",
+ "type": "surface",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='surface'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='surface'))"
},
"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).",
@@ -61223,35 +51082,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='surface'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='surface'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -61259,7 +51118,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='surface'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -61269,7 +51128,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61284,7 +51143,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='surface'))"
},
"role": "object",
"shadow": {
@@ -61292,13 +51151,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='surface'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='surface'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -61309,7 +51168,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61322,7 +51181,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='surface'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -61337,7 +51196,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='surface'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -61350,9 +51209,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='surface'))"
},
"role": "object",
"text": {
@@ -61360,16 +51219,16 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='surface'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61378,75 +51237,45 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='volume'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='surface'))"
},
"x": {
- "description": "Sets the X coordinates of the vertices on X axis.",
+ "description": "Sets the x coordinates.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='volume'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='surface'))"
},
"y": {
- "description": "Sets the Y coordinates of the vertices on Y axis.",
+ "description": "Sets the y coordinates.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='volume'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='surface'))"
},
"z": {
- "description": "Sets the Z coordinates of the vertices on Z axis.",
+ "description": "Sets the z coordinates.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='volume'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='surface'))"
},
- "value": {
- "description": "Sets the 4th dimension (value) of the vertices.",
- "editType": "calc+clearAxisTypes",
+ "surfacecolor": {
+ "description": "Sets the surface color values, used for setting a color scale independent of `z`.",
+ "editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(value=<VALUE>, selector=dict(type='volume'))"
- },
- "valuesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `value`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(surfacecolor=<VALUE>, selector=dict(type='surface'))"
},
"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.",
+ "description": "Sets the text elements associated with each z value. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='volume'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='surface'))"
},
"hovertext": {
"arrayOk": true,
@@ -61454,16 +51283,11 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='volume'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='surface'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -61479,12 +51303,7 @@
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='volume'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='surface'))"
},
"hovertemplate": {
"arrayOk": true,
@@ -61492,70 +51311,48 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='surface'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "calc",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='volume'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='surface'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='volume'))"
- },
- "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.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(valuehoverformat=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='volume'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='volume'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61563,7 +51360,7 @@
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='surface'))"
},
"colorbar": {
"bgcolor": {
@@ -61571,14 +51368,14 @@
"dflt": "rgba(0,0,0,0)",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='surface'))"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='surface'))"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
@@ -61586,17 +51383,17 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='surface'))"
},
"editType": "calc",
"exponentformat": {
@@ -61613,14 +51410,14 @@
"B",
"SI extended"
],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='surface'))"
},
"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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61628,7 +51425,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61639,7 +51436,7 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='surface'))"
},
"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*.",
@@ -61647,7 +51444,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='surface'))"
},
"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*.",
@@ -61655,7 +51452,7 @@
"editType": "calc",
"min": 0,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='surface'))"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
@@ -61666,14 +51463,14 @@
"h",
"v"
],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='surface'))"
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='surface'))"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
@@ -61681,7 +51478,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='surface'))"
},
"role": "object",
"separatethousands": {
@@ -61689,7 +51486,7 @@
"dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61702,14 +51499,14 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='surface'))"
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61722,7 +51519,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='surface'))"
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
@@ -61735,7 +51532,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='surface'))"
},
"thickness": {
"description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
@@ -61743,7 +51540,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61754,37 +51551,37 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='surface'))"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='surface'))"
},
"tickfont": {
"color": {
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='surface'))"
},
"description": "Sets the color bar's tick label font",
"editType": "calc",
@@ -61794,7 +51591,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61809,7 +51606,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='surface'))"
},
"role": "object",
"shadow": {
@@ -61817,13 +51614,13 @@
"dflt": "none",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='surface'))"
},
"size": {
"editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='surface'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -61834,7 +51631,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -61847,7 +51644,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='surface'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -61862,7 +51659,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='surface'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -61875,16 +51672,16 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='surface'))"
},
"tickformatstops": {
"items": {
@@ -61931,7 +51728,7 @@
}
},
"role": "object",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='surface'))"
},
"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*.",
@@ -61942,7 +51739,7 @@
"hide past div",
"hide past domain"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='surface'))"
},
"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*.",
@@ -61961,7 +51758,7 @@
"outside bottom",
"inside bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='surface'))"
},
"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*.",
@@ -61969,7 +51766,7 @@
"editType": "calc",
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='surface'))"
},
"ticklen": {
"description": "Sets the tick length (in px).",
@@ -61977,13 +51774,13 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='surface'))"
},
"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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "enumerated",
"values": [
@@ -61991,14 +51788,14 @@
"linear",
"array"
],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='surface'))"
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -62010,36 +51807,26 @@
"inside",
""
],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='surface'))"
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='volume'))"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='volume'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='surface'))"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
@@ -62047,7 +51834,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='surface'))"
},
"title": {
"editType": "calc",
@@ -62055,7 +51842,7 @@
"color": {
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='surface'))"
},
"description": "Sets this color bar's title font.",
"editType": "calc",
@@ -62065,7 +51852,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -62080,7 +51867,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='surface'))"
},
"role": "object",
"shadow": {
@@ -62088,13 +51875,13 @@
"dflt": "none",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='surface'))"
},
"size": {
"editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='surface'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -62105,7 +51892,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -62118,7 +51905,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='surface'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -62133,7 +51920,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='surface'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -62146,13 +51933,13 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='surface'))"
},
"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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "calc",
"valType": "enumerated",
"values": [
@@ -62160,21 +51947,21 @@
"top",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='surface'))"
},
"text": {
"description": "Sets the title of the color bar.",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='surface'))"
},
"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*.",
@@ -62185,7 +51972,7 @@
"center",
"right"
],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='surface'))"
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
@@ -62193,7 +51980,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -62204,13 +51991,13 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='surface'))"
},
"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*.",
@@ -62221,7 +52008,7 @@
"middle",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='surface'))"
},
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
@@ -62229,7 +52016,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='surface'))"
},
"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.",
@@ -62240,196 +52027,430 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='surface'))"
},
"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,
+ "dflt": false,
"editType": "calc",
"impliedEdits": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='surface'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='surface'))"
},
"showscale": {
"description": "Determines whether or not a colorbar is displayed for this trace.",
"dflt": true,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='surface'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='surface'))"
},
"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.",
+ "description": "Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` are set by the user.",
"dflt": true,
"editType": "calc",
"impliedEdits": {
- "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='surface'))"
},
"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.",
+ "description": "Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmin` must be set as well.",
"dflt": null,
"editType": "calc",
"impliedEdits": {
"cauto": false,
- "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='surface'))"
},
"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`.",
+ "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 z or surfacecolor. Has no effect when `cauto` is `false`.",
"dflt": null,
"editType": "calc",
"impliedEdits": {
- "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='surface'))"
},
"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.",
+ "description": "Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, `cmax` must be set as well.",
"dflt": null,
"editType": "calc",
"impliedEdits": {
"cauto": false,
- "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='surface'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='surface'))"
},
- "caps": {
+ "connectgaps": {
+ "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='surface'))"
+ },
+ "contours": {
"editType": "calc",
"role": "object",
"x": {
+ "color": {
+ "description": "Sets the color of the contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(contours_x_color=<VALUE>, selector=dict(type='surface'))"
+ },
"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,
+ "end": {
+ "description": "Sets the end contour level value. Must be more than `contours.start`",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_x_end=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlight": {
+ "description": "Determines whether or not contour lines about the x dimension are highlighted on hover.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_x_highlight=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlightcolor": {
+ "description": "Sets the color of the highlighted contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(contours_x_highlightcolor=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlightwidth": {
+ "description": "Sets the width of the highlighted contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_x_highlightwidth=<VALUE>, selector=dict(type='surface'))"
+ },
+ "project": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
+ "description": "Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_x_project_x=<VALUE>, selector=dict(type='surface'))"
+ },
+ "y": {
+ "description": "Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_x_project_y=<VALUE>, selector=dict(type='surface'))"
+ },
+ "z": {
+ "description": "Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_x_project_z=<VALUE>, selector=dict(type='surface'))"
+ },
+ "magic_underscores": "fig.update_traces(contours_x_project=dict(...), selector=dict(type='surface'))"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not contour lines about the x dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_x_show=<VALUE>, selector=dict(type='surface'))"
+ },
+ "size": {
+ "description": "Sets the step between each contour level. Must be positive.",
+ "dflt": null,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_x_size=<VALUE>, selector=dict(type='surface'))"
+ },
+ "start": {
+ "description": "Sets the starting contour level value. Must be less than `contours.end`",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_x_start=<VALUE>, selector=dict(type='surface'))"
+ },
+ "usecolormap": {
+ "description": "An alternate to *color*. Determines whether or not the contour lines are colored using the trace *colorscale*.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_x_usecolormap=<VALUE>, selector=dict(type='surface'))"
+ },
+ "width": {
+ "description": "Sets the width of the contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_x_width=<VALUE>, selector=dict(type='surface'))"
+ },
+ "magic_underscores": "fig.update_traces(contours_x=dict(...), selector=dict(type='surface'))"
+ },
+ "y": {
+ "color": {
+ "description": "Sets the color of the contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(contours_y_color=<VALUE>, selector=dict(type='surface'))"
+ },
+ "editType": "calc",
+ "end": {
+ "description": "Sets the end contour level value. Must be more than `contours.start`",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_y_end=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlight": {
+ "description": "Determines whether or not contour lines about the y dimension are highlighted on hover.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_y_highlight=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlightcolor": {
+ "description": "Sets the color of the highlighted contour lines.",
+ "dflt": "#444",
"editType": "calc",
- "max": 1,
- "min": 0,
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(contours_y_highlightcolor=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlightwidth": {
+ "description": "Sets the width of the highlighted contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(caps_x_fill=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(contours_y_highlightwidth=<VALUE>, selector=dict(type='surface'))"
+ },
+ "project": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
+ "description": "Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_y_project_x=<VALUE>, selector=dict(type='surface'))"
+ },
+ "y": {
+ "description": "Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_y_project_y=<VALUE>, selector=dict(type='surface'))"
+ },
+ "z": {
+ "description": "Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_y_project_z=<VALUE>, selector=dict(type='surface'))"
+ },
+ "magic_underscores": "fig.update_traces(contours_y_project=dict(...), selector=dict(type='surface'))"
},
"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,
+ "description": "Determines whether or not contour lines about the y dimension are drawn.",
+ "dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(caps_x_show=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(contours_y_show=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(caps_x=dict(...), selector=dict(type='volume'))"
- },
- "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,
+ "size": {
+ "description": "Sets the step between each contour level. Must be positive.",
+ "dflt": null,
"editType": "calc",
- "max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(caps_y_fill=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(contours_y_size=<VALUE>, selector=dict(type='surface'))"
},
- "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,
+ "start": {
+ "description": "Sets the starting contour level value. Must be less than `contours.end`",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_y_start=<VALUE>, selector=dict(type='surface'))"
+ },
+ "usecolormap": {
+ "description": "An alternate to *color*. Determines whether or not the contour lines are colored using the trace *colorscale*.",
+ "dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(caps_y_show=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(contours_y_usecolormap=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(caps_y=dict(...), selector=dict(type='volume'))"
+ "width": {
+ "description": "Sets the width of the contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_y_width=<VALUE>, selector=dict(type='surface'))"
+ },
+ "magic_underscores": "fig.update_traces(contours_y=dict(...), selector=dict(type='surface'))"
},
"z": {
+ "color": {
+ "description": "Sets the color of the contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(contours_z_color=<VALUE>, selector=dict(type='surface'))"
+ },
"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,
+ "end": {
+ "description": "Sets the end contour level value. Must be more than `contours.start`",
+ "dflt": null,
"editType": "calc",
- "max": 1,
- "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(caps_z_fill=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(contours_z_end=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlight": {
+ "description": "Determines whether or not contour lines about the z dimension are highlighted on hover.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_z_highlight=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlightcolor": {
+ "description": "Sets the color of the highlighted contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(contours_z_highlightcolor=<VALUE>, selector=dict(type='surface'))"
+ },
+ "highlightwidth": {
+ "description": "Sets the width of the highlighted contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_z_highlightwidth=<VALUE>, selector=dict(type='surface'))"
+ },
+ "project": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
+ "description": "Determines whether or not these contour lines are projected on the x plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_z_project_x=<VALUE>, selector=dict(type='surface'))"
+ },
+ "y": {
+ "description": "Determines whether or not these contour lines are projected on the y plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_z_project_y=<VALUE>, selector=dict(type='surface'))"
+ },
+ "z": {
+ "description": "Determines whether or not these contour lines are projected on the z plane. If `highlight` is set to *true* (the default), the projected lines are shown on hover. If `show` is set to *true*, the projected lines are shown in permanence.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_z_project_z=<VALUE>, selector=dict(type='surface'))"
+ },
+ "magic_underscores": "fig.update_traces(contours_z_project=dict(...), selector=dict(type='surface'))"
},
"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,
+ "description": "Determines whether or not contour lines about the z dimension are drawn.",
+ "dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(caps_z_show=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(contours_z_show=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(caps_z=dict(...), selector=dict(type='volume'))"
- },
- "magic_underscores": "fig.update_traces(caps=dict(...), selector=dict(type='volume'))"
- },
- "contour": {
- "color": {
- "description": "Sets the color of the contour lines.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(contour_color=<VALUE>, selector=dict(type='volume'))"
- },
- "editType": "calc",
- "role": "object",
- "show": {
- "description": "Sets whether or not dynamic contours are shown on hover",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(contour_show=<VALUE>, selector=dict(type='volume'))"
- },
- "width": {
- "description": "Sets the width of the contour lines.",
- "dflt": 2,
- "editType": "calc",
- "max": 16,
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(contour_width=<VALUE>, selector=dict(type='volume'))"
+ "size": {
+ "description": "Sets the step between each contour level. Must be positive.",
+ "dflt": null,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_z_size=<VALUE>, selector=dict(type='surface'))"
+ },
+ "start": {
+ "description": "Sets the starting contour level value. Must be less than `contours.end`",
+ "dflt": null,
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_z_start=<VALUE>, selector=dict(type='surface'))"
+ },
+ "usecolormap": {
+ "description": "An alternate to *color*. Determines whether or not the contour lines are colored using the trace *colorscale*.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contours_z_usecolormap=<VALUE>, selector=dict(type='surface'))"
+ },
+ "width": {
+ "description": "Sets the width of the contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contours_z_width=<VALUE>, selector=dict(type='surface'))"
+ },
+ "magic_underscores": "fig.update_traces(contours_z=dict(...), selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(contour=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(contours=dict(...), selector=dict(type='surface'))"
},
- "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,
+ "hidesurface": {
+ "description": "Determines whether or not a surface is drawn. For example, set `hidesurface` to *false* `contours.x.show` to *true* and `contours.y.show` to *true* to draw a wire frame plot.",
+ "dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(flatshading=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(hidesurface=<VALUE>, selector=dict(type='surface'))"
},
"hoverlabel": {
"align": {
@@ -62443,36 +52464,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='volume'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='surface'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='volume'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='surface'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='volume'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='surface'))"
},
"editType": "none",
"font": {
@@ -62480,12 +52486,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='volume'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='surface'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -62496,12 +52497,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='volume'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='surface'))"
},
"lineposition": {
"arrayOk": true,
@@ -62517,12 +52513,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='volume'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='surface'))"
},
"role": "object",
"shadow": {
@@ -62531,24 +52522,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='volume'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='surface'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='volume'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='surface'))"
},
"style": {
"arrayOk": true,
@@ -62560,12 +52541,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='volume'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='surface'))"
},
"textcase": {
"arrayOk": true,
@@ -62579,12 +52555,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='volume'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='surface'))"
},
"variant": {
"arrayOk": true,
@@ -62600,12 +52571,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='volume'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='surface'))"
},
"weight": {
"arrayOk": true,
@@ -62619,14 +52585,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='volume'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='surface'))"
},
"namelength": {
"arrayOk": true,
@@ -62635,12 +52596,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='volume'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='surface'))"
},
"role": "object",
"showarrow": {
@@ -62648,21 +52604,9 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='volume'))"
- },
- "isomax": {
- "description": "Sets the maximum boundary for iso-surface plot.",
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(isomax=<VALUE>, selector=dict(type='volume'))"
- },
- "isomin": {
- "description": "Sets the minimum boundary for iso-surface plot.",
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(isomin=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='surface'))"
},
"lighting": {
"ambient": {
@@ -62672,7 +52616,7 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='surface'))"
},
"diffuse": {
"description": "Represents the extent that incident rays are reflected in a range of angles.",
@@ -62681,18 +52625,9 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='volume'))"
- },
"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,
@@ -62700,7 +52635,7 @@
"max": 5,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='surface'))"
},
"role": "object",
"roughness": {
@@ -62710,7 +52645,7 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='surface'))"
},
"specular": {
"description": "Represents the level that incident rays are reflected in a single direction, causing shine.",
@@ -62719,284 +52654,156 @@
"max": 2,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='volume'))"
- },
- "y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='volume'))"
- },
- "z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
+ "dflt": 10,
"editType": "calc",
"max": 100000,
"min": -100000,
"valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='volume'))"
- },
- "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='volume'))"
- },
- "opacityscale": {
- "description": "Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.",
- "editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(opacityscale=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_x_fill=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_x_locations=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_x_show=<VALUE>, selector=dict(type='volume'))"
- },
- "magic_underscores": "fig.update_traces(slices_x=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='surface'))"
},
"y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 10000,
"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",
- "magic_underscores": "fig.update_traces(slices_y_fill=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_y_locations=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_y_show=<VALUE>, selector=dict(type='volume'))"
- },
- "magic_underscores": "fig.update_traces(slices_y=dict(...), selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_z_fill=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_z_locations=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_z_show=<VALUE>, selector=dict(type='volume'))"
- },
- "magic_underscores": "fig.update_traces(slices_z=dict(...), selector=dict(type='volume'))"
- },
- "magic_underscores": "fig.update_traces(slices=dict(...), selector=dict(type='volume'))"
- },
- "spaceframe": {
- "editType": "calc",
- "fill": {
- "description": "Sets the fill ratio of the `spaceframe` elements. The default fill value is 1 meaning that they are entirely shaded. 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",
- "magic_underscores": "fig.update_traces(spaceframe_fill=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(spaceframe_show=<VALUE>, selector=dict(type='volume'))"
- },
- "magic_underscores": "fig.update_traces(spaceframe=dict(...), selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(surface_count=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(surface_fill=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(surface_pattern=<VALUE>, selector=dict(type='volume'))"
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='surface'))"
},
- "role": "object",
- "show": {
- "description": "Hides/displays surfaces between minimum and maximum iso-values.",
- "dflt": true,
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
"editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(surface_show=<VALUE>, selector=dict(type='volume'))"
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(surface=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='surface'))"
+ },
+ "opacityscale": {
+ "description": "Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.",
+ "editType": "calc",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(opacityscale=<VALUE>, selector=dict(type='surface'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='surface'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='surface'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(zcalendar=<VALUE>, selector=dict(type='surface'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='volume'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='volume'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='surface'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='volume'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='surface'))"
},
"categories": [
"gl3d",
+ "2dMap",
"showLegend"
],
"meta": {
- "description": "Draws volume trace 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."
+ "description": "The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a {2D array}. Coordinates in `x` and `y` can either be 1D {arrays} or {2D arrays} (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the `z` values by default. For custom color scales, use `surfacecolor` which should be a {2D array}, where its bounds can be controlled using `cmin` and `cmax`."
},
- "type": "volume"
+ "type": "surface"
},
- "isosurface": {
+ "mesh3d": {
"animatable": false,
"attributes": {
- "type": "isosurface",
+ "type": "mesh3d",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='mesh3d'))"
},
"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).",
@@ -63008,35 +52815,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='mesh3d'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": false,
- "editType": "calc",
+ "editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='mesh3d'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -63044,7 +52851,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='mesh3d'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -63054,7 +52861,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='mesh3d'))"
},
"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.",
@@ -63069,7 +52876,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='mesh3d'))"
},
"role": "object",
"shadow": {
@@ -63077,13 +52884,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='mesh3d'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='mesh3d'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -63094,7 +52901,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='mesh3d'))"
},
"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.",
@@ -63107,7 +52914,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='mesh3d'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -63122,7 +52929,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='mesh3d'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -63135,9 +52942,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='mesh3d'))"
},
"role": "object",
"text": {
@@ -63145,16 +52952,16 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='mesh3d'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='mesh3d'))"
},
"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.",
@@ -63163,62 +52970,78 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='isosurface'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='mesh3d'))"
},
"x": {
- "description": "Sets the X coordinates of the vertices on X axis.",
+ "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",
- "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='isosurface'))"
- },
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='mesh3d'))"
},
"y": {
- "description": "Sets the Y coordinates of the vertices on Y axis.",
+ "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",
- "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='isosurface'))"
- },
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='mesh3d'))"
},
"z": {
- "description": "Sets the Z coordinates of the vertices on Z axis.",
+ "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",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='mesh3d'))"
},
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "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",
+ "magic_underscores": "fig.update_traces(i=<VALUE>, selector=dict(type='mesh3d'))"
},
- "value": {
- "description": "Sets the 4th dimension (value) of the vertices.",
- "editType": "calc+clearAxisTypes",
+ "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",
- "magic_underscores": "fig.update_traces(value=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(j=<VALUE>, selector=dict(type='mesh3d'))"
},
- "valuesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `value`.",
- "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",
+ "magic_underscores": "fig.update_traces(k=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "facecolor": {
+ "description": "Sets the color of each face Overrides *color* and *vertexcolor*.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(facecolor=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(intensity=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "intensitymode": {
+ "description": "Determines the source of `intensity` values.",
+ "dflt": "vertex",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "vertex",
+ "cell"
+ ],
+ "magic_underscores": "fig.update_traces(intensitymode=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(vertexcolor=<VALUE>, selector=dict(type='mesh3d'))"
},
"text": {
"arrayOk": true,
@@ -63226,12 +53049,7 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='isosurface'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='mesh3d'))"
},
"hovertext": {
"arrayOk": true,
@@ -63239,16 +53057,11 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='isosurface'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='mesh3d'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -63264,12 +53077,7 @@
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='isosurface'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='mesh3d'))"
},
"hovertemplate": {
"arrayOk": true,
@@ -63277,70 +53085,48 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='mesh3d'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "calc",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='isosurface'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='mesh3d'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
+ "editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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.",
+ "description": "Sets the hover text formatting rule for `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",
+ "editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(valuehoverformat=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='isosurface'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='isosurface'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='mesh3d'))"
},
"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.",
@@ -63348,46 +53134,52 @@
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "color": {
+ "description": "Sets the color of the whole mesh",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(color=<VALUE>, selector=dict(type='mesh3d'))"
},
"colorbar": {
"bgcolor": {
"description": "Sets the color of padded area.",
"dflt": "rgba(0,0,0,0)",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='mesh3d'))"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='mesh3d'))"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
"dflt": 0,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='mesh3d'))"
},
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
"dflt": "B",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"none",
@@ -63398,88 +53190,88 @@
"B",
"SI extended"
],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='mesh3d'))"
},
"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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='mesh3d'))"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
"dflt": "v",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"h",
"v"
],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='mesh3d'))"
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='mesh3d'))"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
"dflt": 1,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='mesh3d'))"
},
"role": "object",
"separatethousands": {
"description": "If \"true\", even 4-digit integers are separated",
"dflt": false,
- "editType": "calc",
+ "editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
@@ -63487,19 +53279,19 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='mesh3d'))"
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "calc",
+ "editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
@@ -63507,12 +53299,12 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='mesh3d'))"
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
"dflt": "all",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"all",
@@ -63520,71 +53312,71 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='mesh3d'))"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='mesh3d'))"
},
"tickfont": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='mesh3d'))"
},
"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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='mesh3d'))"
},
"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"
],
@@ -63594,37 +53386,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='mesh3d'))"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
@@ -63632,12 +53424,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='mesh3d'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -63647,12 +53439,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='mesh3d'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -63660,79 +53452,79 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
+ "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"
}
}
},
"role": "object",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='mesh3d'))"
},
"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",
"hide past div",
"hide past domain"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
@@ -63746,29 +53538,29 @@
"outside bottom",
"inside bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='mesh3d'))"
},
"ticklen": {
"description": "Sets the tick length (in px).",
"dflt": 5,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='mesh3d'))"
},
"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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "enumerated",
"values": [
@@ -63776,86 +53568,76 @@
"linear",
"array"
],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='mesh3d'))"
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"inside",
""
],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='mesh3d'))"
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='isosurface'))"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "editType": "colorbars",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='isosurface'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='mesh3d'))"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
"dflt": 1,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='mesh3d'))"
},
"title": {
- "editType": "calc",
+ "editType": "colorbars",
"font": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='mesh3d'))"
},
"description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='mesh3d'))"
},
"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"
],
@@ -63865,37 +53647,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='mesh3d'))"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
@@ -63903,12 +53685,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='mesh3d'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -63918,12 +53700,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='mesh3d'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -63931,255 +53713,206 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='mesh3d'))"
},
"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*.",
- "editType": "calc",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"right",
"top",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='mesh3d'))"
},
"text": {
"description": "Sets the title of the color bar.",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"center",
"right"
],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='mesh3d'))"
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
"dflt": 10,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"middle",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='mesh3d'))"
},
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
"dflt": 10,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='mesh3d'))"
},
"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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='mesh3d'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='mesh3d'))"
},
"showscale": {
"description": "Determines whether or not a colorbar is displayed for this trace.",
"dflt": true,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='mesh3d'))"
},
"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",
+ "editType": "plot",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='mesh3d'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
+ "editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='mesh3d'))"
},
"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.",
+ "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": {
- "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='mesh3d'))"
},
"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.",
+ "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,
- "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='mesh3d'))"
},
"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`.",
+ "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": {
- "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='mesh3d'))"
},
"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.",
+ "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,
- "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='mesh3d'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='mesh3d'))"
},
- "caps": {
+ "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",
- "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": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(caps_x_fill=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(caps_x_show=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(caps_x=dict(...), selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(caps_y_fill=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(caps_y_show=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(caps_y=dict(...), selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(caps_z_fill=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(caps_z_show=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(caps_z=dict(...), selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(caps=dict(...), selector=dict(type='isosurface'))"
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(alphahull=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(delaunayaxis=<VALUE>, selector=dict(type='mesh3d'))"
},
"contour": {
"color": {
@@ -64187,7 +53920,7 @@
"dflt": "#444",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(contour_color=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(contour_color=<VALUE>, selector=dict(type='mesh3d'))"
},
"editType": "calc",
"role": "object",
@@ -64196,7 +53929,7 @@
"dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(contour_show=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(contour_show=<VALUE>, selector=dict(type='mesh3d'))"
},
"width": {
"description": "Sets the width of the contour lines.",
@@ -64205,16 +53938,16 @@
"max": 16,
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(contour_width=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(contour_width=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(contour=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(contour=dict(...), selector=dict(type='mesh3d'))"
},
"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,
+ "dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(flatshading=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(flatshading=<VALUE>, selector=dict(type='mesh3d'))"
},
"hoverlabel": {
"align": {
@@ -64228,36 +53961,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='isosurface'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='mesh3d'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='isosurface'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='mesh3d'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='isosurface'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='mesh3d'))"
},
"editType": "none",
"font": {
@@ -64265,12 +53983,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='isosurface'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='mesh3d'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -64281,12 +53994,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='isosurface'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='mesh3d'))"
},
"lineposition": {
"arrayOk": true,
@@ -64302,12 +54010,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='isosurface'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='mesh3d'))"
},
"role": "object",
"shadow": {
@@ -64316,24 +54019,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='isosurface'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='mesh3d'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='isosurface'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='mesh3d'))"
},
"style": {
"arrayOk": true,
@@ -64345,12 +54038,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='isosurface'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='mesh3d'))"
},
"textcase": {
"arrayOk": true,
@@ -64364,12 +54052,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='isosurface'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='mesh3d'))"
},
"variant": {
"arrayOk": true,
@@ -64385,12 +54068,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='isosurface'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='mesh3d'))"
},
"weight": {
"arrayOk": true,
@@ -64404,14 +54082,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='isosurface'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='mesh3d'))"
},
"namelength": {
"arrayOk": true,
@@ -64420,362 +54093,225 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='isosurface'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='mesh3d'))"
},
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
"dflt": true,
- "editType": "none",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='isosurface'))"
- },
- "isomax": {
- "description": "Sets the maximum boundary for iso-surface plot.",
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(isomax=<VALUE>, selector=dict(type='isosurface'))"
- },
- "isomin": {
- "description": "Sets the minimum boundary for iso-surface plot.",
- "editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(isomin=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='isosurface'))"
- },
- "y": {
- "description": "Numeric vector, representing the Y coordinate for each vertex.",
- "dflt": 100000,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='isosurface'))"
- },
- "z": {
- "description": "Numeric vector, representing the Z coordinate for each vertex.",
- "dflt": 0,
- "editType": "calc",
- "max": 100000,
- "min": -100000,
- "valType": "number",
- "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_x_fill=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_x_locations=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_x_show=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(slices_x=dict(...), selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_y_fill=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_y_locations=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_y_show=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(slices_y=dict(...), selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_z_fill=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_z_locations=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(slices_z_show=<VALUE>, selector=dict(type='isosurface'))"
- },
- "magic_underscores": "fig.update_traces(slices_z=dict(...), selector=dict(type='isosurface'))"
+ "editType": "none",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(slices=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='mesh3d'))"
},
- "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,
+ "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",
- "magic_underscores": "fig.update_traces(spaceframe_fill=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(spaceframe_show=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(spaceframe=dict(...), selector=dict(type='isosurface'))"
- },
- "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,
+ "diffuse": {
+ "description": "Represents the extent that incident rays are reflected in a range of angles.",
+ "dflt": 0.8,
"editType": "calc",
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(surface_count=<VALUE>, selector=dict(type='isosurface'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='mesh3d'))"
},
"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,
+ "facenormalsepsilon": {
+ "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 1e-06,
"editType": "calc",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(surface_fill=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='mesh3d'))"
},
- "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",
+ "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",
- "extras": [
- "all",
- "odd",
- "even"
- ],
- "flags": [
- "A",
- "B",
- "C",
- "D",
- "E"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(surface_pattern=<VALUE>, selector=dict(type='isosurface'))"
+ "max": 5,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='mesh3d'))"
},
"role": "object",
- "show": {
- "description": "Hides/displays surfaces between minimum and maximum iso-values.",
- "dflt": true,
+ "roughness": {
+ "description": "Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.",
+ "dflt": 0.5,
"editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(surface_show=<VALUE>, selector=dict(type='isosurface'))"
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(surface=dict(...), selector=dict(type='isosurface'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='isosurface'))"
- },
- "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,
+ "specular": {
+ "description": "Represents the level that incident rays are reflected in a single direction, causing shine.",
+ "dflt": 0.05,
"editType": "calc",
- "max": 10000,
+ "max": 2,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='mesh3d'))"
},
+ "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='mesh3d'))"
+ },
+ "lightposition": {
+ "editType": "calc",
"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.",
+ "x": {
+ "description": "Numeric vector, representing the X coordinate for each vertex.",
+ "dflt": 100000,
"editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='isosurface'))"
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='isosurface'))"
+ "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='mesh3d'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='isosurface'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(xcalendar=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(ycalendar=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(zcalendar=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='mesh3d'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='mesh3d'))"
},
"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."
+ "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": "isosurface"
+ "type": "mesh3d"
},
- "scattergeo": {
+ "cone": {
"animatable": false,
"attributes": {
- "type": "scattergeo",
+ "type": "cone",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='cone'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='cone'))"
},
"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).",
@@ -64787,35 +54323,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='cone'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -64823,7 +54359,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='cone'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -64833,7 +54369,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='cone'))"
},
"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.",
@@ -64848,7 +54384,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='cone'))"
},
"role": "object",
"shadow": {
@@ -64856,13 +54392,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='cone'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='cone'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -64873,7 +54409,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='cone'))"
},
"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.",
@@ -64886,7 +54422,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='cone'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -64901,7 +54437,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='cone'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -64914,9 +54450,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='cone'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='cone'))"
},
"role": "object",
"text": {
@@ -64924,172 +54460,88 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='cone'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='cone'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='cone'))"
},
- "lat": {
- "description": "Sets the latitude coordinates (in degrees North).",
- "editType": "calc",
+ "x": {
+ "description": "Sets the x coordinates of the vector field and of the displayed cones.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(lat=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='cone'))"
},
- "latsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
- "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",
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='cone'))"
},
- "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",
- "magic_underscores": "fig.update_traces(geojson=<VALUE>, selector=dict(type='scattergeo'))"
+ "z": {
+ "description": "Sets the z coordinates of the vector field and of the displayed cones.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='cone'))"
},
- "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",
+ "u": {
+ "description": "Sets the x components of the vector field.",
"editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(featureidkey=<VALUE>, selector=dict(type='scattergeo'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(u=<VALUE>, selector=dict(type='cone'))"
},
- "locations": {
- "description": "Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.",
+ "v": {
+ "description": "Sets the y components of the vector field.",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(locations=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "locationssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(v=<VALUE>, selector=dict(type='cone'))"
},
- "lon": {
- "description": "Sets the longitude coordinates (in degrees East).",
+ "w": {
+ "description": "Sets the z components of the vector field.",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(lon=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "lonsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(w=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "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"
- ],
- "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`.",
+ "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": "string",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "texttemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='cone'))"
},
"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.",
+ "description": "Same as `text`.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='cone'))"
},
"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",
+ "description": "Determines what trace information appears on hover. 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",
"editType": "calc",
"extras": [
"all",
@@ -65097,398 +54549,593 @@
"skip"
],
"flags": [
- "lon",
- "lat",
- "location",
+ "x",
+ "y",
+ "z",
+ "u",
+ "v",
+ "w",
+ "norm",
"text",
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='cone'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='cone'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "calc",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='cone'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='cone'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='cone'))"
+ },
+ "uhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(uhoverformat=<VALUE>, selector=dict(type='cone'))"
+ },
+ "vhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(vhoverformat=<VALUE>, selector=dict(type='cone'))"
+ },
+ "whoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(whoverformat=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='cone'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='cone'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(geo=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='cone'))"
},
- "marker": {
- "angle": {
- "arrayOk": true,
- "description": "Sets the marker angle in respect to `angleref`.",
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='cone'))"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='cone'))"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
- "valType": "angle",
- "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='scattergeo'))"
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='cone'))"
},
- "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",
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "previous",
- "up",
- "north"
+ "h",
+ "v"
],
- "magic_underscores": "fig.update_traces(marker_angleref=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='cone'))"
},
- "anglesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
- "editType": "none",
- "valType": "string"
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='cone'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='cone'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='cone'))"
},
- "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.",
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='cone'))"
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "calc",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
+ "editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='cone'))"
},
- "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,
- "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='scattergeo'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='cone'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='cone'))"
},
- "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",
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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": {
- "cauto": false,
- "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
+ "tickmode": "linear",
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='cone'))"
},
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='scattergeo'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='cone'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='scattergeo'))"
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='cone'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='scattergeo'))"
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='cone'))"
},
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='cone'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='scattergeo'))"
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='cone'))"
},
- "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"
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
+ "flags": [
+ "under",
+ "over",
+ "through"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='scattergeo'))"
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='cone'))"
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='scattergeo'))"
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='cone'))"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='cone'))"
},
- "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": {
+ "description": "Sets whether a font should be styled with a normal or italic face from its family.",
+ "dflt": "normal",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='cone'))"
},
- "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",
+ "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": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='cone'))"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "calc",
+ "variant": {
+ "description": "Sets the variant of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "small-caps",
+ "all-small-caps",
+ "all-petite-caps",
+ "petite-caps",
+ "unicase"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='cone'))"
},
- "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"
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='scattergeo'))"
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='cone'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ }
+ }
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='scattergeo'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='cone'))"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='cone'))"
},
- "tickfont": {
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='cone'))"
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ ""
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='cone'))"
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='cone'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='cone'))"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
"color": {
- "editType": "calc",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='cone'))"
},
- "description": "Sets the color bar's tick label font",
- "editType": "calc",
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
+ "editType": "colorbars",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='cone'))"
},
"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"
],
@@ -65498,37 +55145,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='cone'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='cone'))"
},
"size": {
- "editType": "calc",
+ "editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='cone'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='cone'))"
},
"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",
@@ -65536,12 +55183,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='cone'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
"normal",
@@ -65551,12 +55198,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='cone'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "calc",
+ "editType": "colorbars",
"extras": [
"normal",
"bold"
@@ -65564,1443 +55211,1587 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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"
- }
- }
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='cone'))"
},
- "role": "object",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='scattergeo'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='cone'))"
},
- "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",
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='cone'))"
},
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='scattergeo'))"
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='cone'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='cone'))"
+ },
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='cone'))"
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='cone'))"
+ },
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='cone'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='cone'))"
+ },
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='cone'))"
+ },
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='cone'))"
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='cone'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(anchor=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='cone'))"
+ },
+ "bgcolor": {
+ "arrayOk": true,
+ "description": "Sets the background color of the hover labels for this trace",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='cone'))"
+ },
+ "bordercolor": {
+ "arrayOk": true,
+ "description": "Sets the border color of the hover labels for this trace.",
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='cone'))"
+ },
+ "editType": "none",
+ "font": {
+ "color": {
+ "arrayOk": true,
+ "editType": "none",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='cone'))"
},
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "calc",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "none",
+ "noBlank": true,
+ "strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='cone'))"
},
- "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",
- ""
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scattergeo'))"
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='cone'))"
},
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
+ "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"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scattergeo'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='cone'))"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
+ "size": {
+ "arrayOk": true,
"editType": "none",
- "valType": "string"
- },
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "title": {
- "editType": "calc",
- "font": {
- "color": {
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='scattergeo'))"
- },
- "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*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='scattergeo'))"
- },
- "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",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='cone'))"
},
- "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",
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='cone'))"
},
- "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",
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='cone'))"
},
- "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",
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='cone'))"
},
- "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"
+ "weight": {
+ "arrayOk": true,
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "none",
+ "extras": [
+ "normal",
+ "bold"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='scattergeo'))"
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='cone'))"
},
- "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='cone'))"
},
- "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,
- "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scattergeo'))"
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='cone'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
+ "role": "object",
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
"editType": "none",
- "valType": "string"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='cone'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='cone'))"
},
"editType": "calc",
- "gradient": {
+ "facenormalsepsilon": {
+ "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 1e-06,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='cone'))"
+ },
+ "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='cone'))"
+ },
+ "y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='cone'))"
+ },
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='cone'))"
+ },
+ "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='cone'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(sizemode=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(sizeref=<VALUE>, selector=dict(type='cone'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='cone'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='cone'))"
+ },
+ "categories": [
+ "gl3d",
+ "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`."
+ },
+ "type": "cone"
+ },
+ "streamtube": {
+ "animatable": false,
+ "attributes": {
+ "type": "streamtube",
+ "name": {
+ "description": "Sets the trace name. The trace name appears as the legend item and on hover.",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "uid": {
+ "description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
+ "editType": "plot",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "showlegend": {
+ "description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
+ "dflt": false,
+ "editType": "style",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "legendgrouptitle": {
+ "editType": "style",
+ "font": {
"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",
+ "editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_gradient_color=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='streamtube'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "style",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='streamtube'))"
},
- "editType": "calc",
- "role": "object",
- "type": {
- "arrayOk": true,
- "description": "Sets the type of gradient used to fill the markers",
+ "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",
- "valType": "enumerated",
- "values": [
- "radial",
- "horizontal",
- "vertical",
+ "editType": "style",
+ "extras": [
"none"
],
- "magic_underscores": "fig.update_traces(marker_gradient_type=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(marker_gradient=dict(...), selector=dict(type='scattergeo'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_line_autocolorscale=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_cauto_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_line_cauto=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_cmax_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmax=<VALUE>, selector=dict(type='scattergeo'))"
+ "flags": [
+ "under",
+ "over",
+ "through"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='streamtube'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(marker_line_cmid_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmid=<VALUE>, selector=dict(type='scattergeo'))"
+ "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='streamtube'))"
},
- "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,
- "magic_underscores": "fig.update_traces(marker_line_cmin_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
+ "size": {
+ "editType": "style",
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_cmin=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_line_colorscale_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='streamtube'))"
},
- "dash": {
- "arrayOk": true,
- "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",
+ "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": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(marker_line_dash=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "dashsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `dash`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_line_reversescale=<VALUE>, selector=dict(type='scattergeo'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='streamtube'))"
},
- "role": "object",
- "width": {
- "arrayOk": true,
- "description": "Sets the width (in px) of the lines bounding the marker points.",
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scattergeo'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='streamtube'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "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",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scattergeo'))"
- },
- "opacity": {
- "arrayOk": true,
- "description": "Sets the marker opacity.",
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='streamtube'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='scattergeo'))"
+ "text": {
+ "description": "Sets the title of the legend group.",
+ "dflt": "",
+ "editType": "style",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='streamtube'))"
},
- "size": {
- "arrayOk": true,
- "description": "Sets the marker size (in px).",
- "dflt": 6,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='streamtube'))"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "x": {
+ "description": "Sets the x coordinates of the vector field.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "y": {
+ "description": "Sets the y coordinates of the vector field.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "z": {
+ "description": "Sets the z coordinates of the vector field.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "u": {
+ "description": "Sets the x components of the vector field.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(u=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "v": {
+ "description": "Sets the y components of the vector field.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(v=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "w": {
+ "description": "Sets the z components of the vector field.",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(w=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "text": {
+ "description": "Sets a text element associated with this trace. If trace `hoverinfo` contains a *text* flag, this text element will be seen in all hover labels. Note that streamtube traces do not support array `text` values.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "hovertext": {
+ "description": "Same as `text`.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "hoverinfo": {
+ "arrayOk": true,
+ "description": "Determines what trace information appears on hover. 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",
+ "editType": "calc",
+ "extras": [
+ "all",
+ "none",
+ "skip"
+ ],
+ "flags": [
+ "x",
+ "y",
+ "z",
+ "u",
+ "v",
+ "w",
+ "norm",
+ "divergence",
+ "text",
+ "name"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. 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",
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "hovertemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "calc",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "uhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(uhoverformat=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "vhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(vhoverformat=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "whoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(whoverformat=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='streamtube'))"
},
- "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.",
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
"dflt": 0,
- "editType": "calc",
+ "editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_sizemin=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "colorbars",
"valType": "enumerated",
"values": [
- "diameter",
- "area"
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
],
- "magic_underscores": "fig.update_traces(marker_sizemode=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='streamtube'))"
},
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(marker_standoff=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "standoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `standoff`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "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": [
- 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"
+ "fraction",
+ "pixels"
],
- "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='streamtube'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scattergeo'))"
- },
- "line": {
- "color": {
- "description": "Sets the line color.",
- "editType": "calc",
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "colorbars",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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": [
- "solid",
- "dot",
- "dash",
- "longdash",
- "dashdot",
- "longdashdot"
+ "all",
+ "first",
+ "last",
+ "none"
],
- "magic_underscores": "fig.update_traces(line_dash=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='streamtube'))"
},
- "editType": "calc",
- "role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
- "editType": "calc",
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "colorbars",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='scattergeo'))"
- },
- "textfont": {
- "color": {
- "arrayOk": true,
- "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": [
+ "fraction",
+ "pixels"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='streamtube'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "tickfont": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='streamtube'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
+ "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",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='streamtube'))"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='streamtube'))"
},
- "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"
+ "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"
],
- "flags": [
- "under",
- "over",
- "through"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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": "flaglist",
- "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='streamtube'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='streamtube'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "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",
+ ""
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "title": {
+ "editType": "colorbars",
+ "font": {
+ "color": {
+ "editType": "colorbars",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "colorbars",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "size": {
+ "editType": "colorbars",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "colorbars",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='streamtube'))"
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "colorbars",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "colorbars",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='streamtube'))"
},
- "size": {
- "arrayOk": true,
- "editType": "calc",
- "min": 1,
+ "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",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='streamtube'))"
},
- "style": {
- "arrayOk": true,
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "calc",
+ "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"
],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "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"
],
- "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='streamtube'))"
},
- "variant": {
- "arrayOk": true,
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "calc",
+ "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"
],
- "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='streamtube'))"
},
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "colorbars",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='streamtube'))"
},
- "weight": {
- "arrayOk": true,
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
+ "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"
],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='streamtube'))"
},
- "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.",
+ "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": "any",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='scattergeo'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='streamtube'))"
},
- "selected": {
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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",
- "marker": {
- "color": {
- "description": "Sets the marker color of selected points.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "editType": "calc",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of selected points.",
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='scattergeo'))"
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of selected points.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(selected_textfont_color=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "editType": "calc",
- "role": "object",
- "magic_underscores": "fig.update_traces(selected_textfont=dict(...), selector=dict(type='scattergeo'))"
+ "impliedEdits": {
+ "autocolorscale": false,
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='scattergeo'))"
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='streamtube'))"
},
- "unselected": {
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
"editType": "calc",
- "marker": {
- "color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "role": "object",
- "size": {
- "description": "Sets the marker size of unselected points, applied only when a selection exists.",
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='scattergeo'))"
- },
- "role": "object",
- "textfont": {
- "color": {
- "description": "Sets the text font color of unselected points, applied only when a selection exists.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(unselected_textfont_color=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "editType": "calc",
- "role": "object",
- "magic_underscores": "fig.update_traces(unselected_textfont=dict(...), selector=dict(type='scattergeo'))"
- },
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='scattergeo'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='streamtube'))"
},
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
+ "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",
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ },
"valType": "boolean",
- "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='streamtube'))"
},
- "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",
+ "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",
- "valType": "enumerated",
- "values": [
- "none",
- "toself"
- ],
- "magic_underscores": "fig.update_traces(fill=<VALUE>, selector=dict(type='scattergeo'))"
+ "impliedEdits": {
+ "cauto": false,
+ "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='streamtube'))"
},
- "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.",
+ "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",
- "valType": "color",
- "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='scattergeo'))"
+ "impliedEdits": {
+ "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='streamtube'))"
},
"hoverlabel": {
"align": {
@@ -67014,36 +56805,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='streamtube'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='streamtube'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='streamtube'))"
},
"editType": "none",
"font": {
@@ -67051,12 +56827,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='streamtube'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -67067,12 +56838,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='streamtube'))"
},
"lineposition": {
"arrayOk": true,
@@ -67088,12 +56854,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='streamtube'))"
},
"role": "object",
"shadow": {
@@ -67102,24 +56863,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='streamtube'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='streamtube'))"
},
"style": {
"arrayOk": true,
@@ -67131,12 +56882,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='streamtube'))"
},
"textcase": {
"arrayOk": true,
@@ -67150,12 +56896,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='streamtube'))"
},
"variant": {
"arrayOk": true,
@@ -67171,12 +56912,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='streamtube'))"
},
"weight": {
"arrayOk": true,
@@ -67190,14 +56926,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='streamtube'))"
},
"namelength": {
"arrayOk": true,
@@ -67206,12 +56937,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scattergeo'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='streamtube'))"
},
"role": "object",
"showarrow": {
@@ -67219,80 +56945,181 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='scattergeo'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='streamtube'))"
},
- "locationmode": {
- "description": "The library used by the *country names* `locationmode` option is changing in an upcoming version. Country names in existing plots may not work in the new version. 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. *USA-states* accepts both two-letter abbreviations (e.g. *CA*) and full state names (e.g. *California*).",
- "dflt": "ISO-3",
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='streamtube'))"
+ },
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "ISO-3",
- "USA-states",
- "country names",
- "geojson-id"
- ],
- "magic_underscores": "fig.update_traces(locationmode=<VALUE>, selector=dict(type='scattergeo'))"
+ "facenormalsepsilon": {
+ "description": "Epsilon for face normals calculation avoids math issues arising from degenerate geometry.",
+ "dflt": 1e-06,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='streamtube'))"
},
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scattergeo'))"
+ "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",
+ "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='streamtube'))"
+ },
+ "maxdisplayed": {
+ "description": "The maximum number of displayed segments in a streamtube.",
+ "dflt": 1000,
+ "editType": "calc",
+ "min": 0,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(maxdisplayed=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "sizeref": {
+ "description": "The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(sizeref=<VALUE>, selector=dict(type='streamtube'))"
},
- "stream": {
+ "starts": {
"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,
+ "role": "object",
+ "x": {
+ "description": "Sets the x components of the starting position of the streamtubes",
"editType": "calc",
- "max": 10000,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scattergeo'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(starts_x=<VALUE>, selector=dict(type='streamtube'))"
},
- "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.",
+ "y": {
+ "description": "Sets the y components of the starting position of the streamtubes",
"editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scattergeo'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(starts_y=<VALUE>, selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scattergeo'))"
+ "z": {
+ "description": "Sets the z components of the starting position of the streamtubes",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(starts_z=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "magic_underscores": "fig.update_traces(starts=dict(...), selector=dict(type='streamtube'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='scattergeo'))"
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='streamtube'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='streamtube'))"
},
"categories": [
- "geo",
- "symbols",
- "showLegend",
- "scatter-like"
+ "gl3d",
+ "showLegend"
],
"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": "Use a streamtube trace to visualize flow in a vector field. Specify a vector field using 6 1D arrays of equal length, 3 position arrays `x`, `y` and `z` and 3 vector component arrays `u`, `v`, and `w`. By default, the tubes' starting positions will be cut from the vector field's x-z plane at its minimum y value. To specify your own starting position, use attributes `starts.x`, `starts.y` and `starts.z`. The color is encoded by the norm of (u, v, w), and the local radius by the divergence of (u, v, w)."
},
- "type": "scattergeo"
+ "type": "streamtube"
},
- "choropleth": {
+ "volume": {
"animatable": false,
"attributes": {
- "type": "choropleth",
+ "type": "volume",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='volume'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='volume'))"
},
"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).",
@@ -67304,35 +57131,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='volume'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -67340,7 +57167,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='volume'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -67350,7 +57177,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='volume'))"
},
"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.",
@@ -67365,7 +57192,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='volume'))"
},
"role": "object",
"shadow": {
@@ -67373,13 +57200,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='volume'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='volume'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -67390,7 +57217,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='volume'))"
},
"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.",
@@ -67403,7 +57230,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='volume'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -67418,7 +57245,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='volume'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -67431,9 +57258,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='volume'))"
},
"role": "object",
"text": {
@@ -67441,75 +57268,63 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='volume'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='choropleth'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='volume'))"
},
- "z": {
- "description": "Sets the color values.",
- "editType": "calc",
+ "x": {
+ "description": "Sets the X coordinates of the vertices on X axis.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='choropleth'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
- "geojson": {
- "description": "Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. 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",
- "magic_underscores": "fig.update_traces(geojson=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='volume'))"
},
- "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",
- "magic_underscores": "fig.update_traces(featureidkey=<VALUE>, selector=dict(type='choropleth'))"
+ "y": {
+ "description": "Sets the Y coordinates of the vertices on Y axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='volume'))"
},
- "locations": {
- "description": "Sets the coordinates via location IDs or names. See `locationmode` for more info.",
- "editType": "calc",
+ "z": {
+ "description": "Sets the Z coordinates of the vertices on Z axis.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(locations=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='volume'))"
},
- "locationssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
- "editType": "none",
- "valType": "string"
+ "value": {
+ "description": "Sets the 4th dimension (value) of the vertices.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(value=<VALUE>, selector=dict(type='volume'))"
},
"text": {
"arrayOk": true,
- "description": "Sets the text elements associated with each location.",
+ "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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='choropleth'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='volume'))"
},
"hovertext": {
"arrayOk": true,
@@ -67517,16 +57332,11 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='choropleth'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='volume'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -67535,68 +57345,70 @@
"skip"
],
"flags": [
- "location",
+ "x",
+ "y",
"z",
"text",
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='choropleth'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='volume'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='volume'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
- "editType": "none",
+ "editType": "calc",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='volume'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='volume'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='volume'))"
+ },
+ "valuehoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(valuehoverformat=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='choropleth'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='choropleth'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='volume'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(geo=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='volume'))"
},
"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.",
@@ -67604,98 +57416,46 @@
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='choropleth'))"
- },
- "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": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='choropleth'))"
- },
- "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 lines bounding the marker points.",
- "dflt": 1,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='choropleth'))"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='choropleth'))"
- },
- "opacity": {
- "arrayOk": true,
- "description": "Sets the opacity of the locations.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='choropleth'))"
- },
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='volume'))"
},
"colorbar": {
"bgcolor": {
"description": "Sets the color of padded area.",
"dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='volume'))"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='volume'))"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
"dflt": 0,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='volume'))"
},
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
"dflt": "B",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"none",
@@ -67706,88 +57466,88 @@
"B",
"SI extended"
],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='volume'))"
},
"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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='volume'))"
},
"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",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='volume'))"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
"dflt": "v",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"h",
"v"
],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='volume'))"
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='volume'))"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='volume'))"
},
"role": "object",
"separatethousands": {
"description": "If \"true\", even 4-digit integers are separated",
"dflt": false,
- "editType": "colorbars",
+ "editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='volume'))"
},
"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",
@@ -67795,19 +57555,19 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='volume'))"
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
- "editType": "colorbars",
+ "editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='volume'))"
},
"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",
@@ -67815,12 +57575,12 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='volume'))"
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
"dflt": "all",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"all",
@@ -67828,71 +57588,71 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='volume'))"
},
"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",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='volume'))"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='volume'))"
},
"tickfont": {
"color": {
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='volume'))"
},
"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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
+ "editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='volume'))"
},
"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"
],
@@ -67902,37 +57662,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='volume'))"
},
"size": {
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='volume'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='volume'))"
},
"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",
@@ -67940,12 +57700,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='volume'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -67955,12 +57715,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='volume'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"normal",
"bold"
@@ -67968,79 +57728,79 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='volume'))"
},
"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",
+ "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"
}
}
},
"role": "object",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='volume'))"
},
"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",
"hide past div",
"hide past domain"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='volume'))"
},
"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",
@@ -68054,29 +57814,29 @@
"outside bottom",
"inside bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='volume'))"
},
"ticklen": {
"description": "Sets the tick length (in px).",
"dflt": 5,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='volume'))"
},
"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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "enumerated",
"values": [
@@ -68084,86 +57844,76 @@
"linear",
"array"
],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='volume'))"
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='volume'))"
},
"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",
"inside",
""
],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='volume'))"
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='choropleth'))"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='choropleth'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='volume'))"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
"dflt": 1,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='volume'))"
},
"title": {
- "editType": "colorbars",
+ "editType": "calc",
"font": {
"color": {
- "editType": "colorbars",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='volume'))"
},
"description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
+ "editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='volume'))"
},
"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"
],
@@ -68173,37 +57923,37 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='volume'))"
},
"size": {
- "editType": "colorbars",
+ "editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='volume'))"
},
"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",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='volume'))"
},
"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",
@@ -68211,12 +57961,12 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='volume'))"
},
"variant": {
"description": "Sets the variant of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"normal",
@@ -68226,12 +57976,12 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='volume'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
- "editType": "colorbars",
+ "editType": "calc",
"extras": [
"normal",
"bold"
@@ -68239,222 +57989,290 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='volume'))"
},
"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*.",
- "editType": "colorbars",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "calc",
"valType": "enumerated",
"values": [
"right",
"top",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='volume'))"
},
"text": {
"description": "Sets the title of the color bar.",
- "editType": "colorbars",
+ "editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='volume'))"
},
"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",
"center",
"right"
],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='volume'))"
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
"dflt": 10,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='volume'))"
},
"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",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='volume'))"
},
"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",
"middle",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='volume'))"
},
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
"dflt": 10,
- "editType": "colorbars",
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='volume'))"
},
"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",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='volume'))"
},
"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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='volume'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='volume'))"
},
"showscale": {
"description": "Determines whether or not a colorbar is displayed for this trace.",
"dflt": true,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='volume'))"
},
"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",
+ "editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='volume'))"
},
- "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.",
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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": {
- "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='volume'))"
},
- "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.",
+ "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": {
- "zauto": false,
- "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "cauto": false,
+ "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='volume'))"
},
- "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`.",
+ "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": {
- "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='volume'))"
},
- "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.",
+ "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": {
- "zauto": false,
- "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
+ "cauto": false,
+ "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='volume'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='volume'))"
},
- "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.",
+ "caps": {
"editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='choropleth'))"
- },
- "selected": {
- "editType": "plot",
- "marker": {
- "editType": "plot",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
+ "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": "calc",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(caps_x_fill=<VALUE>, selector=dict(type='volume'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='choropleth'))"
+ "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",
+ "magic_underscores": "fig.update_traces(caps_x_show=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(caps_x=dict(...), selector=dict(type='volume'))"
},
- "role": "object",
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='choropleth'))"
- },
- "unselected": {
- "editType": "plot",
- "marker": {
- "editType": "plot",
- "opacity": {
- "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "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",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(caps_y_fill=<VALUE>, selector=dict(type='volume'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='choropleth'))"
+ "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",
+ "magic_underscores": "fig.update_traces(caps_y_show=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(caps_y=dict(...), selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(caps_z_fill=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(caps_z_show=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(caps_z=dict(...), selector=dict(type='volume'))"
},
+ "magic_underscores": "fig.update_traces(caps=dict(...), selector=dict(type='volume'))"
+ },
+ "contour": {
+ "color": {
+ "description": "Sets the color of the contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(contour_color=<VALUE>, selector=dict(type='volume'))"
+ },
+ "editType": "calc",
"role": "object",
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='choropleth'))"
+ "show": {
+ "description": "Sets whether or not dynamic contours are shown on hover",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contour_show=<VALUE>, selector=dict(type='volume'))"
+ },
+ "width": {
+ "description": "Sets the width of the contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contour_width=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(contour=dict(...), selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(flatshading=<VALUE>, selector=dict(type='volume'))"
},
"hoverlabel": {
"align": {
@@ -68468,36 +58286,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='choropleth'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='volume'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='choropleth'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='volume'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='choropleth'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='volume'))"
},
"editType": "none",
"font": {
@@ -68505,12 +58308,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='choropleth'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='volume'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -68521,12 +58319,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='choropleth'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='volume'))"
},
"lineposition": {
"arrayOk": true,
@@ -68542,12 +58335,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='choropleth'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='volume'))"
},
"role": "object",
"shadow": {
@@ -68556,24 +58344,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='choropleth'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='volume'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='choropleth'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='volume'))"
},
"style": {
"arrayOk": true,
@@ -68585,12 +58363,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='choropleth'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='volume'))"
},
"textcase": {
"arrayOk": true,
@@ -68604,12 +58377,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='choropleth'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='volume'))"
},
"variant": {
"arrayOk": true,
@@ -68625,12 +58393,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='choropleth'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='volume'))"
},
"weight": {
"arrayOk": true,
@@ -68644,14 +58407,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='choropleth'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='volume'))"
},
"namelength": {
"arrayOk": true,
@@ -68660,91 +58418,326 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='volume'))"
+ },
+ "role": "object",
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='volume'))"
+ },
+ "isomax": {
+ "description": "Sets the maximum boundary for iso-surface plot.",
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(isomax=<VALUE>, selector=dict(type='volume'))"
+ },
+ "isomin": {
+ "description": "Sets the minimum boundary for iso-surface plot.",
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(isomin=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='volume'))"
+ },
+ "y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='volume'))"
+ },
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='volume'))"
+ },
+ "opacityscale": {
+ "description": "Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, `opacityscale` may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.",
+ "editType": "calc",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(opacityscale=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_x_fill=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_x_locations=<VALUE>, selector=dict(type='volume'))"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not slice planes about the x dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(slices_x_show=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(slices_x=dict(...), selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_y_fill=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_y_locations=<VALUE>, selector=dict(type='volume'))"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not slice planes about the y dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(slices_y_show=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(slices_y=dict(...), selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_z_fill=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_z_locations=<VALUE>, selector=dict(type='volume'))"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not slice planes about the z dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(slices_z_show=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(slices_z=dict(...), selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(slices=dict(...), selector=dict(type='volume'))"
+ },
+ "spaceframe": {
+ "editType": "calc",
+ "fill": {
+ "description": "Sets the fill ratio of the `spaceframe` elements. The default fill value is 1 meaning that they are entirely shaded. 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",
+ "magic_underscores": "fig.update_traces(spaceframe_fill=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(spaceframe_show=<VALUE>, selector=dict(type='volume'))"
+ },
+ "magic_underscores": "fig.update_traces(spaceframe=dict(...), selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(surface_count=<VALUE>, selector=dict(type='volume'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "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",
+ "magic_underscores": "fig.update_traces(surface_fill=<VALUE>, selector=dict(type='volume'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(surface_pattern=<VALUE>, selector=dict(type='volume'))"
},
"role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "show": {
+ "description": "Hides/displays surfaces between minimum and maximum iso-values.",
"dflt": true,
- "editType": "none",
+ "editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(surface_show=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='choropleth'))"
- },
- "locationmode": {
- "description": "The library used by the *country names* `locationmode` option is changing in an upcoming version. Country names in existing plots may not work in the new version. 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. *USA-states* accepts both two-letter abbreviations (e.g. *CA*) and full state names (e.g. *California*).",
- "dflt": "ISO-3",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "ISO-3",
- "USA-states",
- "country names",
- "geojson-id"
- ],
- "magic_underscores": "fig.update_traces(locationmode=<VALUE>, selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(surface=dict(...), selector=dict(type='volume'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='choropleth'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='choropleth'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='choropleth'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='volume'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='choropleth'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='volume'))"
},
"categories": [
- "geo",
- "noOpacity",
+ "gl3d",
"showLegend"
],
"meta": {
- "description": "The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`."
+ "description": "Draws volume trace 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": "choropleth"
+ "type": "volume"
},
- "scattermap": {
+ "isosurface": {
"animatable": false,
"attributes": {
- "type": "scattermap",
+ "type": "isosurface",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='isosurface'))"
},
"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).",
@@ -68756,35 +58749,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='isosurface'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
- "dflt": true,
- "editType": "style",
+ "dflt": false,
+ "editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='isosurface'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='isosurface'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='isosurface'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='isosurface'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -68792,7 +58785,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='isosurface'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -68802,7 +58795,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='isosurface'))"
},
"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.",
@@ -68817,7 +58810,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='isosurface'))"
},
"role": "object",
"shadow": {
@@ -68825,13 +58818,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='isosurface'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='isosurface'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -68842,7 +58835,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='isosurface'))"
},
"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.",
@@ -68855,7 +58848,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='isosurface'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -68870,7 +58863,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='isosurface'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -68883,9 +58876,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='isosurface'))"
},
"role": "object",
"text": {
@@ -68893,217 +58886,75 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='isosurface'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='isosurface'))"
},
"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",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "flags": [
- "lines",
- "markers",
- "text"
- ],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='isosurface'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scattermap'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='isosurface'))"
},
- "lat": {
- "description": "Sets the latitude coordinates (in degrees North).",
- "editType": "calc",
+ "x": {
+ "description": "Sets the X coordinates of the vertices on X axis.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(lat=<VALUE>, selector=dict(type='scattermap'))"
- },
- "latsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='isosurface'))"
},
- "lon": {
- "description": "Sets the longitude coordinates (in degrees East).",
- "editType": "calc",
+ "y": {
+ "description": "Sets the Y coordinates of the vertices on Y axis.",
+ "editType": "calc+clearAxisTypes",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(lon=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='isosurface'))"
},
- "lonsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
- "editType": "none",
- "valType": "string"
+ "z": {
+ "description": "Sets the Z coordinates of the vertices on Z axis.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='isosurface'))"
},
- "cluster": {
- "color": {
- "arrayOk": true,
- "description": "Sets the color for each cluster step.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(cluster_color=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cluster_enabled=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cluster_maxzoom=<VALUE>, selector=dict(type='scattermap'))"
- },
- "opacity": {
- "arrayOk": true,
- "description": "Sets the marker opacity.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(cluster_opacity=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cluster_size=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cluster_step=<VALUE>, selector=dict(type='scattermap'))"
- },
- "stepsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `step`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(cluster=dict(...), selector=dict(type='scattermap'))"
+ "value": {
+ "description": "Sets the 4th dimension (value) of the vertices.",
+ "editType": "calc+clearAxisTypes",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(value=<VALUE>, selector=dict(type='isosurface'))"
},
"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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scattermap'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
- "textposition": {
- "arrayOk": false,
- "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"
- ],
- "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scattermap'))"
- },
- "texttemplate": {
- "arrayOk": true,
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`.",
+ "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",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='scattermap'))"
- },
- "texttemplatefallback": {
- "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
- "dflt": "-",
- "editType": "calc",
- "valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scattermap'))"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='isosurface'))"
},
"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.",
+ "description": "Same as `text`.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scattermap'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='isosurface'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -69112,18 +58963,14 @@
"skip"
],
"flags": [
- "lon",
- "lat",
+ "x",
+ "y",
+ "z",
"text",
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scattermap'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='isosurface'))"
},
"hovertemplate": {
"arrayOk": true,
@@ -69131,360 +58978,547 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='isosurface'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "calc",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='isosurface'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "xhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "yhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(yhoverformat=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "valuehoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(valuehoverformat=<VALUE>, selector=dict(type='isosurface'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scattermap'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='isosurface'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='isosurface'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(scene=<VALUE>, selector=dict(type='isosurface'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='isosurface'))"
},
- "marker": {
- "allowoverlap": {
- "description": "Flag to draw all symbols, even if they overlap.",
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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 \u22121 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": "boolean",
- "magic_underscores": "fig.update_traces(marker_allowoverlap=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='isosurface'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='isosurface'))"
},
- "anglesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
- "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='isosurface'))"
},
- "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.",
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
"editType": "calc",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
- },
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='isosurface'))"
},
- "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,
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
"editType": "calc",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
- },
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='isosurface'))"
},
- "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,
+ "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": {
- "cauto": false,
- "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
- },
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='isosurface'))"
},
- "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,
+ "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",
- "impliedEdits": {
- "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
- },
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "enumerated",
+ "values": [
+ "fraction",
+ "pixels"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='isosurface'))"
},
- "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,
+ "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,
- "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ "tickmode": "linear",
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
},
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='isosurface'))"
},
- "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.",
+ "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": "color",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "angle",
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='isosurface'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='isosurface'))"
},
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='scattermap'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
+ "tickfont": {
+ "color": {
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='scattermap'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='isosurface'))"
},
+ "description": "Sets the color bar's tick label font",
"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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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,
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
"editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='scattermap'))"
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='isosurface'))"
},
- "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",
+ "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",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
+ "extras": [
+ "none"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='scattermap'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
+ "flags": [
+ "under",
+ "over",
+ "through"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='isosurface'))"
},
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
+ "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": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='isosurface'))"
},
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
+ "size": {
"editType": "calc",
- "min": 0,
+ "min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='scattermap'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='isosurface'))"
},
- "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",
+ "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": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='scattermap'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='isosurface'))"
},
- "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",
+ "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": [
- "all",
- "first",
- "last",
- "none"
+ "normal",
+ "word caps",
+ "upper",
+ "lower"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='isosurface'))"
},
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
+ "variant": {
+ "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"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='isosurface'))"
},
- "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": "calc",
- "valType": "enumerated",
- "values": [
- "fraction",
- "pixels"
+ "extras": [
+ "normal",
+ "bold"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
- },
- "valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='scattermap'))"
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='isosurface'))"
},
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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"
+ }
+ }
},
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='scattermap'))"
+ "role": "object",
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='isosurface'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
},
- "tickfont": {
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ ""
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "title": {
+ "editType": "calc",
+ "font": {
"color": {
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='isosurface'))"
},
- "description": "Sets the color bar's tick label font",
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
@@ -69492,7 +59526,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='isosurface'))"
},
"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.",
@@ -69507,7 +59541,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='isosurface'))"
},
"role": "object",
"shadow": {
@@ -69515,13 +59549,13 @@
"dflt": "none",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='isosurface'))"
},
"size": {
"editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='isosurface'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -69532,7 +59566,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='isosurface'))"
},
"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.",
@@ -69545,7 +59579,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='isosurface'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -69560,7 +59594,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='isosurface'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -69573,642 +59607,290 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scattermap'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scattermap'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
- },
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='scattermap'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- ""
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='scattermap'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='scattermap'))"
- },
- "title": {
- "editType": "calc",
- "font": {
- "color": {
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='scattermap'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scattermap'))"
- },
- "size": {
- "editType": "calc",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='scattermap'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='scattermap'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='scattermap'))"
- },
- "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*.",
- "editType": "calc",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='scattermap'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='scattermap'))"
- },
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='isosurface'))"
},
- "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` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "calc",
"valType": "enumerated",
"values": [
+ "right",
"top",
- "middle",
"bottom"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='scattermap'))"
- },
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "calc",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='isosurface'))"
},
- "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.",
"editType": "calc",
- "valType": "enumerated",
- "values": [
- "container",
- "paper"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='scattermap'))"
- },
- "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scattermap'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='isosurface'))"
},
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scattermap'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='isosurface'))"
},
- "editType": "calc",
- "opacity": {
- "arrayOk": true,
- "description": "Sets the marker opacity.",
+ "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",
- "max": 1,
- "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='isosurface'))"
},
- "size": {
- "arrayOk": true,
- "description": "Sets the marker size (in px).",
- "dflt": 6,
+ "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",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "enumerated",
+ "values": [
+ "left",
+ "center",
+ "right"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='isosurface'))"
},
- "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,
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_sizemin=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='isosurface'))"
},
- "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",
+ "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": [
- "diameter",
- "area"
+ "container",
+ "paper"
],
- "magic_underscores": "fig.update_traces(marker_sizemode=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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.mapbox.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for *circle* symbols.",
- "dflt": "circle",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scattermap'))"
- },
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scattermap'))"
- },
- "line": {
- "color": {
- "description": "Sets the line color.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='isosurface'))"
},
- "editType": "calc",
- "role": "object",
- "width": {
- "description": "Sets the line width (in px).",
- "dflt": 2,
+ "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",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='scattermap'))"
- },
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='scattermap'))"
- },
- "textfont": {
- "color": {
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='isosurface'))"
},
- "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": {
- "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "dflt": "Open Sans Regular, Arial Unicode MS Regular",
+ "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",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scattermap'))"
- },
- "role": "object",
- "size": {
+ "valType": "enumerated",
+ "values": [
+ "top",
+ "middle",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
"editType": "calc",
- "min": 1,
+ "min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='isosurface'))"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
+ "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": [
- "normal",
- "italic"
+ "container",
+ "paper"
],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='isosurface'))"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "calc",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scattermap'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='isosurface'))"
},
- "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.",
+ "colorscale": {
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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",
- "valType": "any",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='scattermap'))"
+ "impliedEdits": {
+ "autocolorscale": false,
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='isosurface'))"
},
- "selected": {
+ "showscale": {
+ "description": "Determines whether or not a colorbar is displayed for this trace.",
+ "dflt": true,
"editType": "calc",
- "marker": {
- "color": {
- "description": "Sets the marker color of selected points.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='scattermap'))"
- },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "zhoverformat": {
+ "description": "Sets the hover text formatting rule for `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",
+ "magic_underscores": "fig.update_traces(zhoverformat=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(cauto_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(cauto=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(cmax_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmax=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(cmid_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmid=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(cmin_impliedEdits=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cmin=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "caps": {
+ "editType": "calc",
+ "role": "object",
+ "x": {
"editType": "calc",
- "opacity": {
- "description": "Sets the marker opacity of selected points.",
+ "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",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(caps_x_fill=<VALUE>, selector=dict(type='isosurface'))"
},
"role": "object",
- "size": {
- "description": "Sets the marker size of selected points.",
+ "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",
+ "magic_underscores": "fig.update_traces(caps_x_show=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(caps_x=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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",
- "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(caps_y_fill=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='scattermap'))"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='scattermap'))"
- },
- "unselected": {
- "editType": "calc",
- "marker": {
- "color": {
- "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "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": "color",
- "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(caps_y_show=<VALUE>, selector=dict(type='isosurface'))"
},
+ "magic_underscores": "fig.update_traces(caps_y=dict(...), selector=dict(type='isosurface'))"
+ },
+ "z": {
"editType": "calc",
- "opacity": {
- "description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
+ "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",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(caps_z_fill=<VALUE>, selector=dict(type='isosurface'))"
},
"role": "object",
- "size": {
- "description": "Sets the marker size of unselected points, applied only when a selection exists.",
+ "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",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(caps_z_show=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(caps_z=dict(...), selector=dict(type='isosurface'))"
},
- "role": "object",
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(caps=dict(...), selector=dict(type='isosurface'))"
},
- "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 *''*.",
+ "contour": {
+ "color": {
+ "description": "Sets the color of the contour lines.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(contour_color=<VALUE>, selector=dict(type='isosurface'))"
+ },
"editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='scattermap'))"
+ "role": "object",
+ "show": {
+ "description": "Sets whether or not dynamic contours are shown on hover",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(contour_show=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "width": {
+ "description": "Sets the width of the contour lines.",
+ "dflt": 2,
+ "editType": "calc",
+ "max": 16,
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(contour_width=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(contour=dict(...), selector=dict(type='isosurface'))"
},
- "connectgaps": {
- "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.",
- "dflt": false,
+ "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",
- "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(fill=<VALUE>, selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(flatshading=<VALUE>, selector=dict(type='isosurface'))"
},
"hoverlabel": {
"align": {
@@ -70222,36 +59904,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scattermap'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='isosurface'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scattermap'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='isosurface'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scattermap'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='isosurface'))"
},
"editType": "none",
"font": {
@@ -70259,12 +59926,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scattermap'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='isosurface'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -70275,12 +59937,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scattermap'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='isosurface'))"
},
"lineposition": {
"arrayOk": true,
@@ -70296,12 +59953,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scattermap'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='isosurface'))"
},
"role": "object",
"shadow": {
@@ -70310,24 +59962,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scattermap'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='isosurface'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scattermap'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='isosurface'))"
},
"style": {
"arrayOk": true,
@@ -70339,12 +59981,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scattermap'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='isosurface'))"
},
"textcase": {
"arrayOk": true,
@@ -70358,12 +59995,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scattermap'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='isosurface'))"
},
"variant": {
"arrayOk": true,
@@ -70379,12 +60011,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scattermap'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='isosurface'))"
},
"weight": {
"arrayOk": true,
@@ -70398,97 +60025,331 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "role": "object",
+ "showarrow": {
+ "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
+ "dflt": true,
+ "editType": "none",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='isosurface'))"
+ },
+ "isomax": {
+ "description": "Sets the maximum boundary for iso-surface plot.",
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(isomax=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "isomin": {
+ "description": "Sets the minimum boundary for iso-surface plot.",
+ "editType": "calc",
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(isomin=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_ambient=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_diffuse=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_facenormalsepsilon=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_fresnel=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_roughness=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_specular=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lighting_vertexnormalsepsilon=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(lighting=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(lightposition_x=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "y": {
+ "description": "Numeric vector, representing the Y coordinate for each vertex.",
+ "dflt": 100000,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_y=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "z": {
+ "description": "Numeric vector, representing the Z coordinate for each vertex.",
+ "dflt": 0,
+ "editType": "calc",
+ "max": 100000,
+ "min": -100000,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(lightposition_z=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(lightposition=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_x_fill=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_x_locations=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not slice planes about the x dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(slices_x_show=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(slices_x=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_y_fill=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_y_locations=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "role": "object",
+ "show": {
+ "description": "Determines whether or not slice planes about the y dimension are drawn.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(slices_y_show=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(slices_y=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_z_fill=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(slices_z_locations=<VALUE>, selector=dict(type='isosurface'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "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",
+ "magic_underscores": "fig.update_traces(slices_z_show=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(slices_z=dict(...), selector=dict(type='isosurface'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(slices=dict(...), selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(spaceframe_fill=<VALUE>, selector=dict(type='isosurface'))"
},
"role": "object",
- "showarrow": {
- "description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
- "dflt": true,
- "editType": "none",
+ "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",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(spaceframe_show=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='scattermap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(spaceframe=dict(...), selector=dict(type='isosurface'))"
},
- "stream": {
+ "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",
+ "magic_underscores": "fig.update_traces(surface_count=<VALUE>, selector=dict(type='isosurface'))"
+ },
"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,
+ "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": 10000,
+ "max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(surface_fill=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(surface_pattern=<VALUE>, selector=dict(type='isosurface'))"
},
"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.",
+ "show": {
+ "description": "Hides/displays surfaces between minimum and maximum iso-values.",
+ "dflt": true,
"editType": "calc",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scattermap'))"
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(surface_show=<VALUE>, selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scattermap'))"
+ "magic_underscores": "fig.update_traces(surface=dict(...), selector=dict(type='isosurface'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='scattermap'))"
+ "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",
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='isosurface'))"
+ },
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='isosurface'))"
},
"categories": [
- "map",
- "gl",
- "symbols",
- "showLegend",
- "scatter-like"
+ "gl3d",
+ "showLegend"
],
"meta": {
- "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"
+ "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": "scattermap"
+ "type": "isosurface"
},
- "scattermapbox": {
+ "scattergeo": {
"animatable": false,
"attributes": {
- "type": "scattermapbox",
+ "type": "scattergeo",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='scattergeo'))"
},
"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).",
@@ -70500,35 +60361,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='scattergeo'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": true,
"editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='scattergeo'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -70536,7 +60397,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='scattergeo'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -70546,7 +60407,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -70561,7 +60422,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"shadow": {
@@ -70569,13 +60430,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='scattergeo'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='scattergeo'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -70586,7 +60447,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -70599,7 +60460,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='scattergeo'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -70614,7 +60475,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='scattergeo'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -70627,9 +60488,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='scattergeo'))"
},
"role": "object",
"text": {
@@ -70637,16 +60498,16 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='scattergeo'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='scattergeo'))"
},
"opacity": {
"description": "Sets the opacity of the trace.",
@@ -70655,10 +60516,10 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
+ "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": [
@@ -70670,131 +60531,55 @@
"text"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scattergeo'))"
},
"lat": {
"description": "Sets the latitude coordinates (in degrees North).",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(lat=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(lat=<VALUE>, selector=dict(type='scattergeo'))"
},
- "latsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(geojson=<VALUE>, selector=dict(type='scattergeo'))"
},
- "lon": {
- "description": "Sets the longitude coordinates (in degrees East).",
+ "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": "data_array",
- "magic_underscores": "fig.update_traces(lon=<VALUE>, selector=dict(type='scattermapbox'))"
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(featureidkey=<VALUE>, selector=dict(type='scattergeo'))"
},
- "lonsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
- "editType": "none",
- "valType": "string"
+ "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",
+ "magic_underscores": "fig.update_traces(locations=<VALUE>, selector=dict(type='scattergeo'))"
},
- "cluster": {
- "color": {
- "arrayOk": true,
- "description": "Sets the color for each cluster step.",
- "editType": "calc",
- "valType": "color",
- "magic_underscores": "fig.update_traces(cluster_color=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
+ "lon": {
+ "description": "Sets the longitude coordinates (in degrees East).",
"editType": "calc",
- "enabled": {
- "description": "Determines whether clustering is enabled or disabled.",
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(cluster_enabled=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cluster_maxzoom=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "opacity": {
- "arrayOk": true,
- "description": "Sets the marker opacity.",
- "dflt": 1,
- "editType": "calc",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(cluster_opacity=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cluster_size=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(cluster_step=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "stepsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `step`.",
- "editType": "none",
- "valType": "string"
- },
- "magic_underscores": "fig.update_traces(cluster=dict(...), selector=dict(type='scattermapbox'))"
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(lon=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
+ "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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scattergeo'))"
},
"textposition": {
- "arrayOk": false,
+ "arrayOk": true,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
"dflt": "middle center",
"editType": "calc",
@@ -70810,44 +60595,34 @@
"bottom center",
"bottom right"
],
- "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scattergeo'))"
},
"texttemplate": {
"arrayOk": true,
- "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`.",
+ "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
- "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='scattergeo'))"
},
"texttemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "calc",
"valType": "any",
- "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
+ "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",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -70858,16 +60633,12 @@
"flags": [
"lon",
"lat",
+ "location",
"text",
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scattergeo'))"
},
"hovertemplate": {
"arrayOk": true,
@@ -70875,90 +60646,75 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='scattergeo'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "calc",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scattergeo'))"
},
- "subplot": {
- "description": "mapbox subplots and traces are deprecated! Please consider switching to `map` subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as 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",
+ "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",
- "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(geo=<VALUE>, selector=dict(type='scattergeo'))"
},
"marker": {
- "allowoverlap": {
- "description": "Flag to draw all symbols, even if they overlap.",
- "dflt": false,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_allowoverlap=<VALUE>, selector=dict(type='scattermapbox'))"
- },
"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",
+ "description": "Sets the marker angle in respect to `angleref`.",
+ "dflt": 0,
"editType": "calc",
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='scattermapbox'))"
+ "valType": "angle",
+ "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='scattergeo'))"
},
- "anglesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `angle`.",
- "editType": "none",
- "valType": "string"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_angleref=<VALUE>, selector=dict(type='scattergeo'))"
},
"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": {
- "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='scattergeo'))"
},
"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": {
- "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -70966,20 +60722,20 @@
"editType": "calc",
"impliedEdits": {
"cauto": false,
- "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='scattergeo'))"
},
"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": {
- "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -70987,17 +60743,17 @@
"editType": "calc",
"impliedEdits": {
"cauto": false,
- "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71005,7 +60761,7 @@
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='scattergeo'))"
},
"colorbar": {
"bgcolor": {
@@ -71013,14 +60769,14 @@
"dflt": "rgba(0,0,0,0)",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='scattergeo'))"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='scattergeo'))"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
@@ -71028,17 +60784,17 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='scattergeo'))"
},
"editType": "calc",
"exponentformat": {
@@ -71055,14 +60811,14 @@
"B",
"SI extended"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='scattergeo'))"
},
"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 \u22121 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",
- "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71070,7 +60826,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71081,7 +60837,7 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='scattergeo'))"
},
"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*.",
@@ -71089,7 +60845,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='scattergeo'))"
},
"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*.",
@@ -71097,7 +60853,7 @@
"editType": "calc",
"min": 0,
"valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='scattergeo'))"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
@@ -71108,14 +60864,14 @@
"h",
"v"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='scattergeo'))"
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='scattergeo'))"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
@@ -71123,7 +60879,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"separatethousands": {
@@ -71131,7 +60887,7 @@
"dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71144,14 +60900,14 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='scattergeo'))"
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71164,7 +60920,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='scattergeo'))"
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
@@ -71177,7 +60933,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='scattergeo'))"
},
"thickness": {
"description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
@@ -71185,7 +60941,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71196,37 +60952,37 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='scattergeo'))"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='scattergeo'))"
},
"tickfont": {
"color": {
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='scattergeo'))"
},
"description": "Sets the color bar's tick label font",
"editType": "calc",
@@ -71236,7 +60992,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71251,7 +61007,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"shadow": {
@@ -71259,13 +61015,13 @@
"dflt": "none",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scattergeo'))"
},
"size": {
"editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='scattergeo'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -71276,7 +61032,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71289,7 +61045,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scattergeo'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -71304,7 +61060,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scattergeo'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -71317,16 +61073,16 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='scattergeo'))"
},
"tickformatstops": {
"items": {
@@ -71373,7 +61129,7 @@
}
},
"role": "object",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='scattergeo'))"
},
"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*.",
@@ -71384,7 +61140,7 @@
"hide past div",
"hide past domain"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scattergeo'))"
},
"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*.",
@@ -71403,7 +61159,7 @@
"outside bottom",
"inside bottom"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scattergeo'))"
},
"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*.",
@@ -71411,7 +61167,7 @@
"editType": "calc",
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scattergeo'))"
},
"ticklen": {
"description": "Sets the tick length (in px).",
@@ -71419,13 +61175,13 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='scattergeo'))"
},
"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": {
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
},
"valType": "enumerated",
"values": [
@@ -71433,14 +61189,14 @@
"linear",
"array"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='scattergeo'))"
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71452,36 +61208,26 @@
"inside",
""
],
- "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='scattergeo'))"
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scattergeo'))"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
@@ -71489,7 +61235,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='scattergeo'))"
},
"title": {
"editType": "calc",
@@ -71497,7 +61243,7 @@
"color": {
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='scattergeo'))"
},
"description": "Sets this color bar's title font.",
"editType": "calc",
@@ -71507,7 +61253,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71522,7 +61268,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"shadow": {
@@ -71530,13 +61276,13 @@
"dflt": "none",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scattergeo'))"
},
"size": {
"editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='scattergeo'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -71547,7 +61293,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71560,7 +61306,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scattergeo'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -71575,7 +61321,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='scattergeo'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -71588,13 +61334,13 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='scattergeo'))"
},
"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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "calc",
"valType": "enumerated",
"values": [
@@ -71602,21 +61348,21 @@
"top",
"bottom"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='scattergeo'))"
},
"text": {
"description": "Sets the title of the color bar.",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='scattergeo'))"
},
"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*.",
@@ -71627,7 +61373,7 @@
"center",
"right"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='scattergeo'))"
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
@@ -71635,7 +61381,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71646,63 +61392,198 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scattergeo'))"
+ },
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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,
+ "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_gradient_color=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_gradient_type=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_gradient=dict(...), selector=dict(type='scattergeo'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_line_autocolorscale=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_cauto_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_line_cauto=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_line_cmax_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmax=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_line_cmid_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmid=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_line_cmin_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_cmin=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='scattergeo'))"
},
- "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*.",
+ "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": [
- "top",
- "middle",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='scattermapbox'))"
+ "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
+ "valType": "subplotid",
+ "magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scattergeo'))"
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='scattermapbox'))"
+ "impliedEdits": {
+ "autocolorscale": false,
+ "magic_underscores": "fig.update_traces(marker_line_colorscale_impliedEdits=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scattergeo'))"
},
- "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",
+ "dash": {
+ "arrayOk": true,
+ "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",
+ "valType": "string",
"values": [
- "container",
- "paper"
+ "solid",
+ "dot",
+ "dash",
+ "longdash",
+ "dashdot",
+ "longdashdot"
],
- "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_line_dash=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scattermapbox'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='scattermapbox'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_reversescale=<VALUE>, selector=dict(type='scattergeo'))"
},
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "role": "object",
+ "width": {
+ "arrayOk": true,
+ "description": "Sets the width (in px) of the lines bounding the marker points.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scattergeo'))"
},
- "editType": "calc",
"opacity": {
"arrayOk": true,
"description": "Sets the marker opacity.",
@@ -71710,19 +61591,14 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"showscale": {
@@ -71730,7 +61606,7 @@
"dflt": false,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='scattergeo'))"
},
"size": {
"arrayOk": true,
@@ -71739,7 +61615,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71747,7 +61623,7 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_sizemin=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker_sizemin=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71758,41 +61634,543 @@
"diameter",
"area"
],
- "magic_underscores": "fig.update_traces(marker_sizemode=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "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.mapbox.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for *circle* symbols.",
- "dflt": "circle",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_sizemode=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_standoff=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scattergeo'))"
},
"line": {
"color": {
"description": "Sets the line color.",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(line_dash=<VALUE>, selector=dict(type='scattergeo'))"
},
"editType": "calc",
"role": "object",
@@ -71802,35 +62180,62 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='scattergeo'))"
},
"textfont": {
"color": {
+ "arrayOk": true,
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scattergeo'))"
},
- "description": "Sets the icon text font (color=mapbox.layer.paint.text-color, size=mapbox.layer.layout.text-size). Has an effect only when `type` is set to *symbol*.",
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "dflt": "Open Sans Regular, Arial Unicode MS Regular",
"editType": "calc",
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
+ "magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='scattergeo'))"
+ },
"size": {
+ "arrayOk": true,
"editType": "calc",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scattergeo'))"
},
"style": {
+ "arrayOk": true,
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
"dflt": "normal",
"editType": "calc",
@@ -71839,9 +62244,40 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scattergeo'))"
},
"weight": {
+ "arrayOk": true,
"description": "Sets the weight (or boldness) of the font.",
"dflt": "normal",
"editType": "calc",
@@ -71852,15 +62288,15 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='scattergeo'))"
},
"selected": {
"editType": "calc",
@@ -71869,7 +62305,7 @@
"description": "Sets the marker color of selected points.",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='scattergeo'))"
},
"editType": "calc",
"opacity": {
@@ -71878,7 +62314,7 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"size": {
@@ -71886,12 +62322,23 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='scattergeo'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='scattermapbox'))"
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of selected points.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(selected_textfont_color=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "editType": "calc",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(selected_textfont=dict(...), selector=dict(type='scattergeo'))"
+ },
+ "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='scattergeo'))"
},
"unselected": {
"editType": "calc",
@@ -71900,7 +62347,7 @@
"description": "Sets the marker color of unselected points, applied only when a selection exists.",
"editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='scattergeo'))"
},
"editType": "calc",
"opacity": {
@@ -71909,7 +62356,7 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"size": {
@@ -71917,25 +62364,30 @@
"editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='scattergeo'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='scattermapbox'))"
- },
- "below": {
- "description": "Determines if this scattermapbox trace's layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set `below` to *''*.",
- "editType": "calc",
- "valType": "string",
- "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='scattermapbox'))"
+ "textfont": {
+ "color": {
+ "description": "Sets the text font color of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(unselected_textfont_color=<VALUE>, selector=dict(type='scattergeo'))"
+ },
+ "editType": "calc",
+ "role": "object",
+ "magic_underscores": "fig.update_traces(unselected_textfont=dict(...), selector=dict(type='scattergeo'))"
+ },
+ "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='scattergeo'))"
},
"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.",
@@ -71946,13 +62398,13 @@
"none",
"toself"
],
- "magic_underscores": "fig.update_traces(fill=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(fill=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='scattergeo'))"
},
"hoverlabel": {
"align": {
@@ -71966,36 +62418,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scattergeo'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scattergeo'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scattergeo'))"
},
"editType": "none",
"font": {
@@ -72003,12 +62440,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scattergeo'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -72019,12 +62451,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scattergeo'))"
},
"lineposition": {
"arrayOk": true,
@@ -72040,12 +62467,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"shadow": {
@@ -72054,24 +62476,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scattergeo'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scattergeo'))"
},
"style": {
"arrayOk": true,
@@ -72083,12 +62495,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scattergeo'))"
},
"textcase": {
"arrayOk": true,
@@ -72102,12 +62509,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scattergeo'))"
},
"variant": {
"arrayOk": true,
@@ -72123,12 +62525,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scattergeo'))"
},
"weight": {
"arrayOk": true,
@@ -72142,14 +62539,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scattergeo'))"
},
"namelength": {
"arrayOk": true,
@@ -72158,12 +62550,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scattergeo'))"
},
"role": "object",
"showarrow": {
@@ -72171,68 +62558,58 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='scattergeo'))"
+ },
+ "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. *USA-states* accepts both two-letter abbreviations (e.g. *CA*) and full state names (e.g. *California*).",
+ "dflt": "ISO-3",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "ISO-3",
+ "USA-states",
+ "country names",
+ "geojson-id"
+ ],
+ "magic_underscores": "fig.update_traces(locationmode=<VALUE>, selector=dict(type='scattergeo'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scattermapbox'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scattergeo'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='scattermapbox'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='scattergeo'))"
},
"categories": [
- "mapbox",
- "gl",
+ "geo",
"symbols",
"showLegend",
"scatter-like"
],
"meta": {
- "description": "*scattermapbox* trace is deprecated! Please consider switching to the *scattermap* trace type and `map` subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as 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"
+ "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": "scattermapbox"
+ "type": "scattergeo"
},
- "choroplethmap": {
+ "choropleth": {
"animatable": false,
"attributes": {
- "type": "choroplethmap",
+ "type": "choropleth",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='choropleth'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='choropleth'))"
},
"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).",
@@ -72244,35 +62621,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='choropleth'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": false,
"editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='choropleth'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -72280,7 +62657,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='choropleth'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -72290,7 +62667,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72305,7 +62682,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
"shadow": {
@@ -72313,13 +62690,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='choropleth'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='choropleth'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -72330,7 +62707,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72343,7 +62720,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='choropleth'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -72358,7 +62735,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='choropleth'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -72371,9 +62748,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='choropleth'))"
},
"role": "object",
"text": {
@@ -72381,62 +62758,47 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='choropleth'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='choropleth'))"
},
"z": {
"description": "Sets the color values.",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='choropleth'))"
},
"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*.",
+ "description": "Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. 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",
- "magic_underscores": "fig.update_traces(geojson=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(geojson=<VALUE>, selector=dict(type='choropleth'))"
},
"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*.",
+ "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",
- "magic_underscores": "fig.update_traces(featureidkey=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(featureidkey=<VALUE>, selector=dict(type='choropleth'))"
},
"locations": {
- "description": "Sets which features found in *geojson* to plot using their feature `id` field.",
+ "description": "Sets the coordinates via location IDs or names. See `locationmode` for more info.",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(locations=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "locationssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(locations=<VALUE>, selector=dict(type='choropleth'))"
},
"text": {
"arrayOk": true,
@@ -72444,12 +62806,7 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='choropleth'))"
},
"hovertext": {
"arrayOk": true,
@@ -72457,16 +62814,11 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -72481,62 +62833,42 @@
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='choropleth'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='choropleth'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "none",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='choropleth'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(geo=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72544,7 +62876,7 @@
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='choropleth'))"
},
"marker": {
"editType": "calc",
@@ -72553,14 +62885,9 @@
"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",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='choropleth'))"
},
"editType": "calc",
"role": "object",
@@ -72568,35 +62895,25 @@
"arrayOk": true,
"description": "Sets the width (in px) of the lines bounding the marker points.",
"dflt": 1,
- "editType": "plot",
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='choropleth'))"
},
"opacity": {
"arrayOk": true,
"description": "Sets the opacity of the locations.",
"dflt": 1,
- "editType": "plot",
+ "editType": "style",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='choropleth'))"
},
"colorbar": {
"bgcolor": {
@@ -72604,14 +62921,14 @@
"dflt": "rgba(0,0,0,0)",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='choropleth'))"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='choropleth'))"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
@@ -72619,17 +62936,17 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='choropleth'))"
},
"editType": "colorbars",
"exponentformat": {
@@ -72646,14 +62963,14 @@
"B",
"SI extended"
],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='choropleth'))"
},
"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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72661,7 +62978,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72672,7 +62989,7 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='choropleth'))"
},
"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*.",
@@ -72680,7 +62997,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='choropleth'))"
},
"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*.",
@@ -72688,7 +63005,7 @@
"editType": "colorbars",
"min": 0,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='choropleth'))"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
@@ -72699,14 +63016,14 @@
"h",
"v"
],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='choropleth'))"
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='choropleth'))"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
@@ -72714,7 +63031,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
"separatethousands": {
@@ -72722,7 +63039,7 @@
"dflt": false,
"editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72735,14 +63052,14 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='choropleth'))"
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
"editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72755,7 +63072,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='choropleth'))"
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
@@ -72768,7 +63085,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='choropleth'))"
},
"thickness": {
"description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
@@ -72776,7 +63093,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72787,37 +63104,37 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='choropleth'))"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='choropleth'))"
},
"tickfont": {
"color": {
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='choropleth'))"
},
"description": "Sets the color bar's tick label font",
"editType": "colorbars",
@@ -72827,7 +63144,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72842,7 +63159,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
"shadow": {
@@ -72850,13 +63167,13 @@
"dflt": "none",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='choropleth'))"
},
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='choropleth'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -72867,7 +63184,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -72880,7 +63197,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='choropleth'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -72895,7 +63212,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='choropleth'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -72908,16 +63225,16 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='choropleth'))"
},
"tickformatstops": {
"items": {
@@ -72964,7 +63281,7 @@
}
},
"role": "object",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='choropleth'))"
},
"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*.",
@@ -72975,7 +63292,7 @@
"hide past div",
"hide past domain"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='choropleth'))"
},
"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*.",
@@ -72994,7 +63311,7 @@
"outside bottom",
"inside bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='choropleth'))"
},
"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*.",
@@ -73002,7 +63319,7 @@
"editType": "colorbars",
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='choropleth'))"
},
"ticklen": {
"description": "Sets the tick length (in px).",
@@ -73010,13 +63327,13 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='choropleth'))"
},
"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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "enumerated",
"values": [
@@ -73024,14 +63341,14 @@
"linear",
"array"
],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='choropleth'))"
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -73043,36 +63360,26 @@
"inside",
""
],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='choropleth'))"
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='choropleth'))"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
@@ -73080,7 +63387,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='choropleth'))"
},
"title": {
"editType": "colorbars",
@@ -73088,7 +63395,7 @@
"color": {
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='choropleth'))"
},
"description": "Sets this color bar's title font.",
"editType": "colorbars",
@@ -73098,7 +63405,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -73113,7 +63420,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
"shadow": {
@@ -73121,13 +63428,13 @@
"dflt": "none",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='choropleth'))"
},
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='choropleth'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -73138,7 +63445,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -73151,7 +63458,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='choropleth'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -73166,7 +63473,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='choropleth'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -73179,13 +63486,13 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='choropleth'))"
},
"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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -73193,21 +63500,21 @@
"top",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='choropleth'))"
},
"text": {
"description": "Sets the title of the color bar.",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='choropleth'))"
},
"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*.",
@@ -73218,7 +63525,7 @@
"center",
"right"
],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='choropleth'))"
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
@@ -73226,7 +63533,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -73237,13 +63544,13 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='choropleth'))"
},
"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*.",
@@ -73254,7 +63561,7 @@
"middle",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='choropleth'))"
},
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
@@ -73262,7 +63569,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -73273,54 +63580,54 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='choropleth'))"
},
"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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='choropleth'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='choropleth'))"
},
"showscale": {
"description": "Determines whether or not a colorbar is displayed for this trace.",
"dflt": true,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='choropleth'))"
},
"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": {
- "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -73328,20 +63635,20 @@
"editType": "calc",
"impliedEdits": {
"zauto": false,
- "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='choropleth'))"
},
"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": {
- "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='choropleth'))"
},
"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.",
@@ -73349,16 +63656,16 @@
"editType": "calc",
"impliedEdits": {
"zauto": false,
- "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='choropleth'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='choropleth'))"
},
"selected": {
"editType": "plot",
@@ -73366,17 +63673,17 @@
"editType": "plot",
"opacity": {
"description": "Sets the marker opacity of selected points.",
- "editType": "plot",
+ "editType": "calc",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='choropleth'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='choropleth'))"
},
"unselected": {
"editType": "plot",
@@ -73384,23 +63691,17 @@
"editType": "plot",
"opacity": {
"description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
- "editType": "plot",
+ "editType": "calc",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='choropleth'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='choroplethmap'))"
- },
- "below": {
- "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",
- "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='choropleth'))"
},
"hoverlabel": {
"align": {
@@ -73414,36 +63715,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='choropleth'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='choropleth'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='choropleth'))"
},
"editType": "none",
"font": {
@@ -73451,12 +63737,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='choropleth'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -73467,12 +63748,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='choropleth'))"
},
"lineposition": {
"arrayOk": true,
@@ -73488,12 +63764,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
"shadow": {
@@ -73502,24 +63773,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='choropleth'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='choropleth'))"
},
"style": {
"arrayOk": true,
@@ -73531,12 +63792,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='choropleth'))"
},
"textcase": {
"arrayOk": true,
@@ -73550,12 +63806,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='choropleth'))"
},
"variant": {
"arrayOk": true,
@@ -73571,12 +63822,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='choropleth'))"
},
"weight": {
"arrayOk": true,
@@ -73590,14 +63836,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='choropleth'))"
},
"namelength": {
"arrayOk": true,
@@ -73606,12 +63847,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='choropleth'))"
},
"role": "object",
"showarrow": {
@@ -73619,67 +63855,56 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='choropleth'))"
+ },
+ "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. *USA-states* accepts both two-letter abbreviations (e.g. *CA*) and full state names (e.g. *California*).",
+ "dflt": "ISO-3",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "ISO-3",
+ "USA-states",
+ "country names",
+ "geojson-id"
+ ],
+ "magic_underscores": "fig.update_traces(locationmode=<VALUE>, selector=dict(type='choropleth'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='choroplethmap'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='choropleth'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='choroplethmap'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='choropleth'))"
},
"categories": [
- "map",
- "gl",
+ "geo",
"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_map"
+ "description": "The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`."
},
- "type": "choroplethmap"
+ "type": "choropleth"
},
- "choroplethmapbox": {
+ "scattermap": {
"animatable": false,
"attributes": {
- "type": "choroplethmapbox",
+ "type": "scattermap",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='scattermap'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='scattermap'))"
},
"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).",
@@ -73691,35 +63916,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='scattermap'))"
},
"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",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='scattermap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='scattermap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='scattermap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='scattermap'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -73727,7 +63952,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='scattermap'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -73737,7 +63962,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='scattermap'))"
},
"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.",
@@ -73752,7 +63977,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='scattermap'))"
},
"role": "object",
"shadow": {
@@ -73760,13 +63985,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='scattermap'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='scattermap'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -73777,7 +64002,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='scattermap'))"
},
"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.",
@@ -73790,7 +64015,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='scattermap'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -73805,7 +64030,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='scattermap'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -73818,9 +64043,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='scattermap'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='scattermap'))"
},
"role": "object",
"text": {
@@ -73828,92 +64053,167 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='scattermap'))"
+ },
+ "legendwidth": {
+ "description": "Sets the width (in px or fraction) of the legend for this trace.",
+ "editType": "style",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "opacity": {
+ "description": "Sets the opacity of the trace.",
+ "dflt": 1,
+ "editType": "style",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "flags": [
+ "lines",
+ "markers",
+ "text"
+ ],
+ "valType": "flaglist",
+ "magic_underscores": "fig.update_traces(mode=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "lat": {
+ "description": "Sets the latitude coordinates (in degrees North).",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(lat=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "lon": {
+ "description": "Sets the longitude coordinates (in degrees East).",
+ "editType": "calc",
+ "valType": "data_array",
+ "magic_underscores": "fig.update_traces(lon=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "cluster": {
+ "color": {
+ "arrayOk": true,
+ "description": "Sets the color for each cluster step.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(cluster_color=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "editType": "calc",
+ "enabled": {
+ "description": "Determines whether clustering is enabled or disabled.",
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(cluster_enabled=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(cluster_maxzoom=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the marker opacity.",
+ "dflt": 1,
+ "editType": "calc",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cluster_opacity=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "role": "object",
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the size for each cluster step.",
+ "dflt": 20,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(cluster_size=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(cluster_step=<VALUE>, selector=dict(type='scattermap'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='choroplethmapbox'))"
- },
- "legendwidth": {
- "description": "Sets the width (in px or fraction) of the legend for this trace.",
- "editType": "style",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
- "z": {
- "description": "Sets the color values.",
- "editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "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",
- "magic_underscores": "fig.update_traces(geojson=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(cluster=dict(...), selector=dict(type='scattermap'))"
},
- "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",
+ "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",
- "magic_underscores": "fig.update_traces(featureidkey=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scattermap'))"
},
- "locations": {
- "description": "Sets which features found in *geojson* to plot using their feature `id` field.",
+ "textposition": {
+ "arrayOk": false,
+ "description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
+ "dflt": "middle center",
"editType": "calc",
- "valType": "data_array",
- "magic_underscores": "fig.update_traces(locations=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "locationssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `locations`.",
- "editType": "none",
- "valType": "string"
+ "valType": "enumerated",
+ "values": [
+ "top left",
+ "top center",
+ "top right",
+ "middle left",
+ "middle center",
+ "middle right",
+ "bottom left",
+ "bottom center",
+ "bottom right"
+ ],
+ "magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scattermap'))"
},
- "text": {
+ "texttemplate": {
"arrayOk": true,
- "description": "Sets the text elements associated with each location.",
+ "description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(texttemplate=<VALUE>, selector=dict(type='scattermap'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "texttemplatefallback": {
+ "description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
+ "dflt": "-",
+ "editType": "calc",
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scattermap'))"
},
"hovertext": {
"arrayOk": true,
- "description": "Same as `text`.",
+ "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",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scattermap'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -73922,932 +64222,1048 @@
"skip"
],
"flags": [
- "location",
- "z",
+ "lon",
+ "lat",
"text",
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scattermap'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
+ "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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='scattermap'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
- "editType": "none",
+ "editType": "calc",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scattermap'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scattermap'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scattermap'))"
},
"subplot": {
- "description": "mapbox subplots and traces are deprecated! Please consider switching to `map` subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as 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",
- "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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,
+ "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",
- "regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='scattermap'))"
},
"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.",
+ "allowoverlap": {
+ "description": "Flag to draw all symbols, even if they overlap.",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_allowoverlap=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_autocolorscale_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_autocolorscale=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_cauto_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_cauto=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_cmax_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmax=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_cmid_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmid=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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,
+ "magic_underscores": "fig.update_traces(marker_cmin_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_cmin=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_color=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_coloraxis=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "colorbar": {
+ "bgcolor": {
+ "description": "Sets the color of padded area.",
+ "dflt": "rgba(0,0,0,0)",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_bgcolor=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "bordercolor": {
+ "description": "Sets the axis line color.",
"dflt": "#444",
- "editType": "plot",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_bordercolor=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "borderwidth": {
+ "description": "Sets the width (in px) or the border enclosing this color bar.",
+ "dflt": 0,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_borderwidth=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(marker_colorbar_dtick=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
+ "dflt": "B",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "none",
+ "e",
+ "E",
+ "power",
+ "SI",
+ "B",
+ "SI extended"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_exponentformat=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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 \u22121 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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_labelalias=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_len=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_lenmode=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_minexponent=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_nticks=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "orientation": {
+ "description": "Sets the orientation of the colorbar.",
+ "dflt": "v",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "h",
+ "v"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_orientation=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "outlinecolor": {
+ "description": "Sets the axis line color.",
+ "dflt": "#444",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinecolor=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "outlinewidth": {
+ "description": "Sets the width (in px) of the axis line.",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_outlinewidth=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "role": "object",
+ "separatethousands": {
+ "description": "If \"true\", even 4-digit integers are separated",
+ "dflt": false,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_colorbar_separatethousands=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showexponent=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "showticklabels": {
+ "description": "Determines whether or not the tick labels are drawn.",
+ "dflt": true,
+ "editType": "calc",
+ "valType": "boolean",
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticklabels=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showtickprefix=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "showticksuffix": {
+ "description": "Same as `showtickprefix` but for tick suffixes.",
+ "dflt": "all",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "all",
+ "first",
+ "last",
+ "none"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_showticksuffix=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_thickness=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_thicknessmode=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tick0=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickangle=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "tickcolor": {
+ "description": "Sets the tick color.",
+ "dflt": "#444",
+ "editType": "calc",
"valType": "color",
- "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickcolor=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "tickfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_color=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_family=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_shadow=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_size=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_style=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_textcase=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_variant=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont_weight=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickfont=dict(...), selector=dict(type='scattermap'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "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": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformat=<VALUE>, selector=dict(type='scattermap'))"
},
- "editType": "calc",
- "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",
- "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickformatstops=list(...), selector=dict(type='scattermap'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "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": "calc",
+ "valType": "enumerated",
+ "values": [
+ "allow",
+ "hide past div",
+ "hide past domain"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='scattermap'))"
},
- "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='choroplethmapbox'))"
- },
- "opacity": {
- "arrayOk": true,
- "description": "Sets the opacity of the locations.",
- "dflt": 1,
- "editType": "plot",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "editType": "none",
- "valType": "string"
- },
- "role": "object",
- "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='choroplethmapbox'))"
- },
- "colorbar": {
- "bgcolor": {
- "description": "Sets the color of padded area.",
- "dflt": "rgba(0,0,0,0)",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "bordercolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "borderwidth": {
- "description": "Sets the width (in px) or the border enclosing this color bar.",
- "dflt": 0,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelposition=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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. *SI* uses prefixes from \"femto\" f (10^-15) to \"tera\" T (10^12). *SI extended* covers instead the full SI range from \"quecto\" q (10^-30) to \"quetta\" Q (10^30). If *SI* or *SI extended* is used and the exponent is beyond the above ranges, the formatting rule will automatically be switched to the power notation.",
- "dflt": "B",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "none",
- "e",
- "E",
- "power",
- "SI",
- "B",
- "SI extended"
- ],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "orientation": {
- "description": "Sets the orientation of the colorbar.",
- "dflt": "v",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "h",
- "v"
- ],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "outlinecolor": {
- "description": "Sets the axis line color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "outlinewidth": {
- "description": "Sets the width (in px) of the axis line.",
- "dflt": 1,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "role": "object",
- "separatethousands": {
- "description": "If \"true\", even 4-digit integers are separated",
- "dflt": false,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "showticklabels": {
- "description": "Determines whether or not the tick labels are drawn.",
- "dflt": true,
- "editType": "colorbars",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "showticksuffix": {
- "description": "Same as `showtickprefix` but for tick suffixes.",
- "dflt": "all",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "all",
- "first",
- "last",
- "none"
- ],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklabelstep=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "tickcolor": {
- "description": "Sets the tick color.",
- "dflt": "#444",
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "tickfont": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "ticklen": {
+ "description": "Sets the tick length (in px).",
+ "dflt": 5,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticklen=<VALUE>, selector=dict(type='scattermap'))"
},
- "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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
+ "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": {
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "linear",
+ "array"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickmode=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "tickprefix": {
+ "description": "Sets a tick label prefix.",
+ "dflt": "",
+ "editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickprefix=<VALUE>, selector=dict(type='scattermap'))"
},
- "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"
+ "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",
+ ""
],
- "valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticks=<VALUE>, selector=dict(type='scattermap'))"
},
- "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",
+ "ticksuffix": {
+ "description": "Sets a tick label suffix.",
+ "dflt": "",
+ "editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticksuffix=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "tickwidth": {
+ "description": "Sets the tick width (in px).",
+ "dflt": 1,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_tickwidth=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "title": {
+ "editType": "calc",
+ "font": {
+ "color": {
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_color=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_family=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_lineposition=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_shadow=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_size=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_style=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_textcase=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_variant=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font_weight=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_font=dict(...), selector=dict(type='scattermap'))"
+ },
+ "role": "object",
+ "side": {
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "right",
+ "top",
+ "bottom"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_side=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "text": {
+ "description": "Sets the title of the color bar.",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_colorbar_title_text=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_colorbar_title=dict(...), selector=dict(type='scattermap'))"
},
- "size": {
- "editType": "colorbars",
- "min": 1,
+ "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",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_x=<VALUE>, selector=dict(type='scattermap'))"
},
- "style": {
- "description": "Sets whether a font should be styled with a normal or italic face from its family.",
- "dflt": "normal",
- "editType": "colorbars",
+ "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",
- "italic"
+ "left",
+ "center",
+ "right"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xanchor=<VALUE>, selector=dict(type='scattermap'))"
},
- "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",
+ "xpad": {
+ "description": "Sets the amount of padding (in px) along the x direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_xpad=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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": [
- "normal",
- "word caps",
- "upper",
- "lower"
+ "container",
+ "paper"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_xref=<VALUE>, selector=dict(type='scattermap'))"
},
- "variant": {
- "description": "Sets the variant of the font.",
- "dflt": "normal",
- "editType": "colorbars",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_colorbar_y=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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": [
- "normal",
- "small-caps",
- "all-small-caps",
- "all-petite-caps",
- "petite-caps",
- "unicase"
+ "top",
+ "middle",
+ "bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar_yanchor=<VALUE>, selector=dict(type='scattermap'))"
},
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "ypad": {
+ "description": "Sets the amount of padding (in px) along the y direction.",
+ "dflt": 10,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_colorbar_ypad=<VALUE>, selector=dict(type='scattermap'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- }
- }
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(marker_colorbar_yref=<VALUE>, selector=dict(type='scattermap'))"
},
- "role": "object",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "ticklen": {
- "description": "Sets the tick length (in px).",
- "dflt": 5,
- "editType": "colorbars",
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scattermap'))"
},
- "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",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "autocolorscale": false,
+ "magic_underscores": "fig.update_traces(marker_colorscale_impliedEdits=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "enumerated",
- "values": [
- "auto",
- "linear",
- "array"
- ],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "tickprefix": {
- "description": "Sets a tick label prefix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- ""
- ],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "ticksuffix": {
- "description": "Sets a tick label suffix.",
- "dflt": "",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "valType": "colorscale",
+ "magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scattermap'))"
},
- "tickwidth": {
- "description": "Sets the tick width (in px).",
- "dflt": 1,
- "editType": "colorbars",
+ "editType": "calc",
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the marker opacity.",
+ "editType": "calc",
+ "max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "title": {
- "editType": "colorbars",
- "font": {
- "color": {
- "editType": "colorbars",
- "valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "description": "Sets this 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 can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
- "editType": "colorbars",
- "noBlank": true,
- "strict": true,
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "size": {
- "editType": "colorbars",
- "min": 1,
- "valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "weight": {
- "description": "Sets the weight (or boldness) of the font.",
- "dflt": "normal",
- "editType": "colorbars",
- "extras": [
- "normal",
- "bold"
- ],
- "max": 1000,
- "min": 1,
- "valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='choroplethmapbox'))"
- },
- "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*.",
- "editType": "colorbars",
- "valType": "enumerated",
- "values": [
- "right",
- "top",
- "bottom"
- ],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "text": {
- "description": "Sets the title of the color bar.",
- "editType": "colorbars",
- "valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scattermap'))"
},
- "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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_reversescale=<VALUE>, selector=dict(type='scattermap'))"
},
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_showscale=<VALUE>, selector=dict(type='scattermap'))"
},
- "xpad": {
- "description": "Sets the amount of padding (in px) along the x direction.",
- "dflt": 10,
- "editType": "colorbars",
+ "size": {
+ "arrayOk": true,
+ "description": "Sets the marker size (in px).",
+ "dflt": 6,
+ "editType": "calc",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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"
- ],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_size=<VALUE>, selector=dict(type='scattermap'))"
},
- "ypad": {
- "description": "Sets the amount of padding (in px) along the y direction.",
- "dflt": 10,
- "editType": "colorbars",
+ "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",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_sizemin=<VALUE>, selector=dict(type='scattermap'))"
},
- "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",
+ "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": [
- "container",
- "paper"
+ "diameter",
+ "area"
],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker_sizemode=<VALUE>, selector=dict(type='scattermap'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='choroplethmapbox'))"
- },
- "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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "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",
+ "magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "symbol": {
+ "arrayOk": true,
+ "description": "Sets the marker symbol. Full list: https://www.mapbox.com/maki-icons/ Note that the array `marker.color` and `marker.size` are only available for *circle* symbols.",
+ "dflt": "circle",
+ "editType": "calc",
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "showscale": {
- "description": "Determines whether or not a colorbar is displayed for this trace.",
- "dflt": true,
- "editType": "calc",
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scattermap'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "line": {
+ "color": {
+ "description": "Sets the line color.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(line_color=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "boolean",
- "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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,
- "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "role": "object",
+ "width": {
+ "description": "Sets the line width (in px).",
+ "dflt": 2,
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(line_width=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(line=dict(...), selector=dict(type='scattermap'))"
},
- "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": {
- "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "textfont": {
+ "color": {
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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,
+ "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",
- "impliedEdits": {
- "zauto": false,
- "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "family": {
+ "description": "HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren't available.",
+ "dflt": "Open Sans Regular, Arial Unicode MS Regular",
+ "editType": "calc",
+ "noBlank": true,
+ "strict": true,
+ "valType": "string",
+ "magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scattermap'))"
},
- "valType": "number",
- "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "role": "object",
+ "size": {
+ "editType": "calc",
+ "min": 1,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "weight": {
+ "description": "Sets the weight (or boldness) of the font.",
+ "dflt": "normal",
+ "editType": "calc",
+ "extras": [
+ "normal",
+ "bold"
+ ],
+ "max": 1000,
+ "min": 1,
+ "valType": "integer",
+ "magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scattermap'))"
},
"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",
- "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='scattermap'))"
},
"selected": {
- "editType": "plot",
+ "editType": "calc",
"marker": {
- "editType": "plot",
+ "color": {
+ "description": "Sets the marker color of selected points.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(selected_marker_color=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "editType": "calc",
"opacity": {
"description": "Sets the marker opacity of selected points.",
- "editType": "plot",
+ "editType": "calc",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='scattermap'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='choroplethmapbox'))"
+ "size": {
+ "description": "Sets the marker size of selected points.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(selected_marker_size=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='scattermap'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='scattermap'))"
},
"unselected": {
- "editType": "plot",
+ "editType": "calc",
"marker": {
- "editType": "plot",
+ "color": {
+ "description": "Sets the marker color of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "valType": "color",
+ "magic_underscores": "fig.update_traces(unselected_marker_color=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "editType": "calc",
"opacity": {
"description": "Sets the marker opacity of unselected points, applied only when a selection exists.",
- "editType": "plot",
+ "editType": "calc",
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='scattermap'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='choroplethmapbox'))"
+ "size": {
+ "description": "Sets the marker size of unselected points, applied only when a selection exists.",
+ "editType": "calc",
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(unselected_marker_size=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='scattermap'))"
},
"role": "object",
- "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='scattermap'))"
},
"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",
+ "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",
- "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(connectgaps=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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"
+ ],
+ "magic_underscores": "fig.update_traces(fill=<VALUE>, selector=dict(type='scattermap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(fillcolor=<VALUE>, selector=dict(type='scattermap'))"
},
"hoverlabel": {
"align": {
@@ -74861,36 +65277,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scattermap'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scattermap'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scattermap'))"
},
"editType": "none",
"font": {
@@ -74898,12 +65299,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scattermap'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -74914,12 +65310,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scattermap'))"
},
"lineposition": {
"arrayOk": true,
@@ -74935,12 +65326,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scattermap'))"
},
"role": "object",
"shadow": {
@@ -74949,24 +65335,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scattermap'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scattermap'))"
},
"style": {
"arrayOk": true,
@@ -74978,12 +65354,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scattermap'))"
},
"textcase": {
"arrayOk": true,
@@ -74997,12 +65368,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scattermap'))"
},
"variant": {
"arrayOk": true,
@@ -75018,12 +65384,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scattermap'))"
},
"weight": {
"arrayOk": true,
@@ -75037,14 +65398,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scattermap'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scattermap'))"
},
"namelength": {
"arrayOk": true,
@@ -75053,12 +65409,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scattermap'))"
},
"role": "object",
"showarrow": {
@@ -75066,67 +65417,46 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='scattermap'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='scattermap'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='choroplethmapbox'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scattermap'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='choroplethmapbox'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='scattermap'))"
},
"categories": [
- "mapbox",
+ "map",
"gl",
- "noOpacity",
- "showLegend"
+ "symbols",
+ "showLegend",
+ "scatter-like"
],
"meta": {
- "description": "*choroplethmapbox* trace is deprecated! Please consider switching to the *choroplethmap* trace type and `map` subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as 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"
+ "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": "choroplethmapbox"
+ "type": "scattermap"
},
- "densitymap": {
+ "choroplethmap": {
"animatable": false,
"attributes": {
- "type": "densitymap",
+ "type": "choroplethmap",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='choroplethmap'))"
},
"uid": {
"description": "Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.",
"editType": "plot",
"valType": "string",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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).",
@@ -75138,35 +65468,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='choroplethmap'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": false,
"editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='choroplethmap'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -75174,7 +65504,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='choroplethmap'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -75184,7 +65514,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75199,7 +65529,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='choroplethmap'))"
},
"role": "object",
"shadow": {
@@ -75207,13 +65537,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='choroplethmap'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='choroplethmap'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -75224,7 +65554,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75237,7 +65567,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='choroplethmap'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -75252,7 +65582,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='choroplethmap'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -75265,9 +65595,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='choroplethmap'))"
},
"role": "object",
"text": {
@@ -75275,184 +65605,117 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='choroplethmap'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='densitymap'))"
- },
- "opacity": {
- "description": "Sets the opacity of the trace.",
- "dflt": 1,
- "editType": "style",
- "max": 1,
- "min": 0,
- "valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='densitymap'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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 color values.",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='densitymap'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
- "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",
- "magic_underscores": "fig.update_traces(radius=<VALUE>, selector=dict(type='densitymap'))"
- },
- "radiussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `radius`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "lat": {
- "description": "Sets the latitude coordinates (in degrees North).",
+ "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": "data_array",
- "magic_underscores": "fig.update_traces(lat=<VALUE>, selector=dict(type='densitymap'))"
+ "valType": "any",
+ "magic_underscores": "fig.update_traces(geojson=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "latsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
- "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",
+ "magic_underscores": "fig.update_traces(featureidkey=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "lon": {
- "description": "Sets the longitude coordinates (in degrees East).",
+ "locations": {
+ "description": "Sets which features found in *geojson* to plot using their feature `id` field.",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(lon=<VALUE>, selector=dict(type='densitymap'))"
- },
- "lonsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(locations=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
+ "description": "Sets the text elements associated with each location.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='densitymap'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
+ "description": "Same as `text`.",
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='densitymap'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
- "lon",
- "lat",
+ "location",
"z",
"text",
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='densitymap'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='choroplethmap'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "none",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='densitymap'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='densitymap'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='densitymap'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75460,7 +65723,44 @@
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='choroplethmap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='choroplethmap'))"
+ },
+ "editType": "calc",
+ "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",
+ "magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='choroplethmap'))"
+ },
+ "magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='choroplethmap'))"
+ },
+ "opacity": {
+ "arrayOk": true,
+ "description": "Sets the opacity of the locations.",
+ "dflt": 1,
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='choroplethmap'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='choroplethmap'))"
},
"colorbar": {
"bgcolor": {
@@ -75468,14 +65768,14 @@
"dflt": "rgba(0,0,0,0)",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='choroplethmap'))"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='choroplethmap'))"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
@@ -75483,17 +65783,17 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='choroplethmap'))"
},
"editType": "colorbars",
"exponentformat": {
@@ -75510,14 +65810,14 @@
"B",
"SI extended"
],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75525,7 +65825,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75536,7 +65836,7 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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*.",
@@ -75544,7 +65844,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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*.",
@@ -75552,7 +65852,7 @@
"editType": "colorbars",
"min": 0,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='choroplethmap'))"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
@@ -75563,14 +65863,14 @@
"h",
"v"
],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='choroplethmap'))"
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='choroplethmap'))"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
@@ -75578,7 +65878,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='choroplethmap'))"
},
"role": "object",
"separatethousands": {
@@ -75586,7 +65886,7 @@
"dflt": false,
"editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75599,14 +65899,14 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='choroplethmap'))"
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
"editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75619,7 +65919,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='choroplethmap'))"
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
@@ -75632,7 +65932,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='choroplethmap'))"
},
"thickness": {
"description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
@@ -75640,7 +65940,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75651,37 +65951,37 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='choroplethmap'))"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='choroplethmap'))"
},
"tickfont": {
"color": {
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='choroplethmap'))"
},
"description": "Sets the color bar's tick label font",
"editType": "colorbars",
@@ -75691,7 +65991,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75706,7 +66006,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='choroplethmap'))"
},
"role": "object",
"shadow": {
@@ -75714,13 +66014,13 @@
"dflt": "none",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='choroplethmap'))"
},
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='choroplethmap'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -75731,7 +66031,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75744,7 +66044,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='choroplethmap'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -75759,7 +66059,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='choroplethmap'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -75772,16 +66072,16 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='choroplethmap'))"
},
"tickformatstops": {
"items": {
@@ -75828,7 +66128,7 @@
}
},
"role": "object",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='choroplethmap'))"
},
"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*.",
@@ -75839,7 +66139,7 @@
"hide past div",
"hide past domain"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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*.",
@@ -75858,7 +66158,7 @@
"outside bottom",
"inside bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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*.",
@@ -75866,7 +66166,7 @@
"editType": "colorbars",
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='choroplethmap'))"
},
"ticklen": {
"description": "Sets the tick length (in px).",
@@ -75874,13 +66174,13 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "enumerated",
"values": [
@@ -75888,14 +66188,14 @@
"linear",
"array"
],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='choroplethmap'))"
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75907,36 +66207,26 @@
"inside",
""
],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='choroplethmap'))"
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='densitymap'))"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='densitymap'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='choroplethmap'))"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
@@ -75944,7 +66234,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='choroplethmap'))"
},
"title": {
"editType": "colorbars",
@@ -75952,7 +66242,7 @@
"color": {
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='choroplethmap'))"
},
"description": "Sets this color bar's title font.",
"editType": "colorbars",
@@ -75962,7 +66252,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -75977,7 +66267,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='choroplethmap'))"
},
"role": "object",
"shadow": {
@@ -75985,13 +66275,13 @@
"dflt": "none",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='choroplethmap'))"
},
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='choroplethmap'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -76002,7 +66292,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -76015,7 +66305,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='choroplethmap'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -76030,7 +66320,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='choroplethmap'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -76043,13 +66333,13 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='choroplethmap'))"
},
"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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -76057,21 +66347,21 @@
"top",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='choroplethmap'))"
},
"text": {
"description": "Sets the title of the color bar.",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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*.",
@@ -76082,7 +66372,7 @@
"center",
"right"
],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='choroplethmap'))"
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
@@ -76090,7 +66380,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -76101,13 +66391,13 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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*.",
@@ -76118,7 +66408,7 @@
"middle",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='choroplethmap'))"
},
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
@@ -76126,7 +66416,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -76137,54 +66427,54 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='choroplethmap'))"
},
"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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='choroplethmap'))"
},
"showscale": {
"description": "Determines whether or not a colorbar is displayed for this trace.",
"dflt": true,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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": {
- "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -76192,20 +66482,20 @@
"editType": "calc",
"impliedEdits": {
"zauto": false,
- "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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": {
- "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='choroplethmap'))"
},
"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.",
@@ -76213,16 +66503,58 @@
"editType": "calc",
"impliedEdits": {
"zauto": false,
- "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='choroplethmap'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='choroplethmap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(selectedpoints=<VALUE>, selector=dict(type='choroplethmap'))"
+ },
+ "selected": {
+ "editType": "plot",
+ "marker": {
+ "editType": "plot",
+ "opacity": {
+ "description": "Sets the marker opacity of selected points.",
+ "editType": "plot",
+ "max": 1,
+ "min": 0,
+ "valType": "number",
+ "magic_underscores": "fig.update_traces(selected_marker_opacity=<VALUE>, selector=dict(type='choroplethmap'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(selected_marker=dict(...), selector=dict(type='choroplethmap'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(selected=dict(...), selector=dict(type='choroplethmap'))"
+ },
+ "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",
+ "magic_underscores": "fig.update_traces(unselected_marker_opacity=<VALUE>, selector=dict(type='choroplethmap'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(unselected_marker=dict(...), selector=dict(type='choroplethmap'))"
+ },
+ "role": "object",
+ "magic_underscores": "fig.update_traces(unselected=dict(...), selector=dict(type='choroplethmap'))"
},
"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.",
+ "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",
- "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='choroplethmap'))"
},
"hoverlabel": {
"align": {
@@ -76236,36 +66568,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='densitymap'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='choroplethmap'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='densitymap'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='choroplethmap'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='densitymap'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='choroplethmap'))"
},
"editType": "none",
"font": {
@@ -76273,12 +66590,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='densitymap'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='choroplethmap'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -76289,12 +66601,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='densitymap'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='choroplethmap'))"
},
"lineposition": {
"arrayOk": true,
@@ -76310,12 +66617,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='densitymap'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='choroplethmap'))"
},
"role": "object",
"shadow": {
@@ -76324,24 +66626,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='densitymap'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='choroplethmap'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='densitymap'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='choroplethmap'))"
},
"style": {
"arrayOk": true,
@@ -76353,12 +66645,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='densitymap'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='choroplethmap'))"
},
"textcase": {
"arrayOk": true,
@@ -76372,12 +66659,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='densitymap'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='choroplethmap'))"
},
"variant": {
"arrayOk": true,
@@ -76393,12 +66675,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='densitymap'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='choroplethmap'))"
},
"weight": {
"arrayOk": true,
@@ -76412,14 +66689,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='densitymap'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='choroplethmap'))"
},
"namelength": {
"arrayOk": true,
@@ -76428,12 +66700,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='densitymap'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='choroplethmap'))"
},
"role": "object",
"showarrow": {
@@ -76441,66 +66708,45 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='choroplethmap'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='densitymap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='densitymap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='densitymap'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='choroplethmap'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='densitymap'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='choroplethmap'))"
},
"categories": [
"map",
"gl",
+ "noOpacity",
"showLegend"
],
"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_map"
+ "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_map"
},
- "type": "densitymap"
+ "type": "choroplethmap"
},
- "densitymapbox": {
+ "densitymap": {
"animatable": false,
"attributes": {
- "type": "densitymapbox",
+ "type": "densitymap",
"name": {
"description": "Sets the trace name. The trace name appears as the legend item and on hover.",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(name=<VALUE>, selector=dict(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",
- "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(uid=<VALUE>, selector=dict(type='densitymap'))"
},
"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).",
@@ -76512,35 +66758,35 @@
false,
"legendonly"
],
- "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(visible=<VALUE>, selector=dict(type='densitymap'))"
},
"showlegend": {
"description": "Determines whether or not an item corresponding to this trace is shown in the legend.",
"dflt": false,
"editType": "style",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(showlegend=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legend=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendrank=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgroup=<VALUE>, selector=dict(type='densitymap'))"
},
"legendgrouptitle": {
"editType": "style",
@@ -76548,7 +66794,7 @@
"color": {
"editType": "style",
"valType": "color",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_color=<VALUE>, selector=dict(type='densitymap'))"
},
"description": "Sets this legend group's title font.",
"editType": "style",
@@ -76558,7 +66804,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_family=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -76573,7 +66819,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_lineposition=<VALUE>, selector=dict(type='densitymap'))"
},
"role": "object",
"shadow": {
@@ -76581,13 +66827,13 @@
"dflt": "none",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_shadow=<VALUE>, selector=dict(type='densitymap'))"
},
"size": {
"editType": "style",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_size=<VALUE>, selector=dict(type='densitymap'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -76598,7 +66844,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_style=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -76611,7 +66857,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_textcase=<VALUE>, selector=dict(type='densitymap'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -76626,7 +66872,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_variant=<VALUE>, selector=dict(type='densitymap'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -76639,9 +66885,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font_weight=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_font=dict(...), selector=dict(type='densitymap'))"
},
"role": "object",
"text": {
@@ -76649,16 +66895,16 @@
"dflt": "",
"editType": "style",
"valType": "string",
- "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle_text=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendgrouptitle=dict(...), selector=dict(type='densitymap'))"
},
"legendwidth": {
"description": "Sets the width (in px or fraction) of the legend for this trace.",
"editType": "style",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(legendwidth=<VALUE>, selector=dict(type='densitymap'))"
},
"opacity": {
"description": "Sets the opacity of the trace.",
@@ -76667,65 +66913,40 @@
"max": 1,
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(opacity=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
+ "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",
- "magic_underscores": "fig.update_traces(radius=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "radiussrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `radius`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(radius=<VALUE>, selector=dict(type='densitymap'))"
},
"lat": {
"description": "Sets the latitude coordinates (in degrees North).",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(lat=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "latsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lat`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(lat=<VALUE>, selector=dict(type='densitymap'))"
},
"lon": {
"description": "Sets the longitude coordinates (in degrees East).",
"editType": "calc",
"valType": "data_array",
- "magic_underscores": "fig.update_traces(lon=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "lonsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lon`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(lon=<VALUE>, selector=dict(type='densitymap'))"
},
"text": {
"arrayOk": true,
@@ -76733,12 +66954,7 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='densitymap'))"
},
"hovertext": {
"arrayOk": true,
@@ -76746,16 +66962,11 @@
"dflt": "",
"editType": "calc",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -76771,12 +66982,7 @@
"name"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='densitymap'))"
},
"hovertemplate": {
"arrayOk": true,
@@ -76784,49 +66990,34 @@
"dflt": "",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(hovertemplate=<VALUE>, selector=dict(type='densitymap'))"
},
"hovertemplatefallback": {
"description": "Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.",
"dflt": "-",
"editType": "none",
"valType": "any",
- "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='densitymap'))"
},
"subplot": {
- "description": "mapbox subplots and traces are deprecated! Please consider switching to `map` subplots and traces. Learn more at: https://plotly.com/python/maplibre-migration/ as well as 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",
+ "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",
- "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(subplot=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -76834,7 +67025,7 @@
"editType": "calc",
"regex": "/^coloraxis([2-9]|[1-9][0-9]+)?$/",
"valType": "subplotid",
- "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(coloraxis=<VALUE>, selector=dict(type='densitymap'))"
},
"colorbar": {
"bgcolor": {
@@ -76842,14 +67033,14 @@
"dflt": "rgba(0,0,0,0)",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_bgcolor=<VALUE>, selector=dict(type='densitymap'))"
},
"bordercolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_bordercolor=<VALUE>, selector=dict(type='densitymap'))"
},
"borderwidth": {
"description": "Sets the width (in px) or the border enclosing this color bar.",
@@ -76857,17 +67048,17 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_borderwidth=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_dtick=<VALUE>, selector=dict(type='densitymap'))"
},
"editType": "colorbars",
"exponentformat": {
@@ -76884,14 +67075,14 @@
"B",
"SI extended"
],
- "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_exponentformat=<VALUE>, selector=dict(type='densitymap'))"
},
"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 \u22121 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",
- "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_labelalias=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -76899,7 +67090,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_len=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -76910,7 +67101,7 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_lenmode=<VALUE>, selector=dict(type='densitymap'))"
},
"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*.",
@@ -76918,7 +67109,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_minexponent=<VALUE>, selector=dict(type='densitymap'))"
},
"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*.",
@@ -76926,7 +67117,7 @@
"editType": "colorbars",
"min": 0,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_nticks=<VALUE>, selector=dict(type='densitymap'))"
},
"orientation": {
"description": "Sets the orientation of the colorbar.",
@@ -76937,14 +67128,14 @@
"h",
"v"
],
- "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_orientation=<VALUE>, selector=dict(type='densitymap'))"
},
"outlinecolor": {
"description": "Sets the axis line color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinecolor=<VALUE>, selector=dict(type='densitymap'))"
},
"outlinewidth": {
"description": "Sets the width (in px) of the axis line.",
@@ -76952,7 +67143,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_outlinewidth=<VALUE>, selector=dict(type='densitymap'))"
},
"role": "object",
"separatethousands": {
@@ -76960,7 +67151,7 @@
"dflt": false,
"editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_separatethousands=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -76973,14 +67164,14 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_showexponent=<VALUE>, selector=dict(type='densitymap'))"
},
"showticklabels": {
"description": "Determines whether or not the tick labels are drawn.",
"dflt": true,
"editType": "colorbars",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticklabels=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -76993,7 +67184,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_showtickprefix=<VALUE>, selector=dict(type='densitymap'))"
},
"showticksuffix": {
"description": "Same as `showtickprefix` but for tick suffixes.",
@@ -77006,7 +67197,7 @@
"last",
"none"
],
- "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_showticksuffix=<VALUE>, selector=dict(type='densitymap'))"
},
"thickness": {
"description": "Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.",
@@ -77014,7 +67205,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_thickness=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77025,37 +67216,37 @@
"fraction",
"pixels"
],
- "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_thicknessmode=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "any",
- "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tick0=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickangle=<VALUE>, selector=dict(type='densitymap'))"
},
"tickcolor": {
"description": "Sets the tick color.",
"dflt": "#444",
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickcolor=<VALUE>, selector=dict(type='densitymap'))"
},
"tickfont": {
"color": {
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_color=<VALUE>, selector=dict(type='densitymap'))"
},
"description": "Sets the color bar's tick label font",
"editType": "colorbars",
@@ -77065,7 +67256,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_family=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77080,7 +67271,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_lineposition=<VALUE>, selector=dict(type='densitymap'))"
},
"role": "object",
"shadow": {
@@ -77088,13 +67279,13 @@
"dflt": "none",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_shadow=<VALUE>, selector=dict(type='densitymap'))"
},
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_size=<VALUE>, selector=dict(type='densitymap'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -77105,7 +67296,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_style=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77118,7 +67309,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_textcase=<VALUE>, selector=dict(type='densitymap'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -77133,7 +67324,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_variant=<VALUE>, selector=dict(type='densitymap'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -77146,16 +67337,16 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont_weight=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickfont=dict(...), selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformat=<VALUE>, selector=dict(type='densitymap'))"
},
"tickformatstops": {
"items": {
@@ -77202,7 +67393,7 @@
}
},
"role": "object",
- "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickformatstops=list(...), selector=dict(type='densitymap'))"
},
"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*.",
@@ -77213,7 +67404,7 @@
"hide past div",
"hide past domain"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabeloverflow=<VALUE>, selector=dict(type='densitymap'))"
},
"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*.",
@@ -77232,7 +67423,7 @@
"outside bottom",
"inside bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelposition=<VALUE>, selector=dict(type='densitymap'))"
},
"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*.",
@@ -77240,7 +67431,7 @@
"editType": "colorbars",
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklabelstep=<VALUE>, selector=dict(type='densitymap'))"
},
"ticklen": {
"description": "Sets the tick length (in px).",
@@ -77248,13 +67439,13 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticklen=<VALUE>, selector=dict(type='densitymap'))"
},
"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": {
- "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "enumerated",
"values": [
@@ -77262,14 +67453,14 @@
"linear",
"array"
],
- "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickmode=<VALUE>, selector=dict(type='densitymap'))"
},
"tickprefix": {
"description": "Sets a tick label prefix.",
"dflt": "",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickprefix=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77281,36 +67472,26 @@
"inside",
""
],
- "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticks=<VALUE>, selector=dict(type='densitymap'))"
},
"ticksuffix": {
"description": "Sets a tick label suffix.",
"dflt": "",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_ticksuffix=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "ticktextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ticktext`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='densitymap'))"
},
"tickwidth": {
"description": "Sets the tick width (in px).",
@@ -77318,7 +67499,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_tickwidth=<VALUE>, selector=dict(type='densitymap'))"
},
"title": {
"editType": "colorbars",
@@ -77326,7 +67507,7 @@
"color": {
"editType": "colorbars",
"valType": "color",
- "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_color=<VALUE>, selector=dict(type='densitymap'))"
},
"description": "Sets this color bar's title font.",
"editType": "colorbars",
@@ -77336,7 +67517,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_family=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77351,7 +67532,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_lineposition=<VALUE>, selector=dict(type='densitymap'))"
},
"role": "object",
"shadow": {
@@ -77359,13 +67540,13 @@
"dflt": "none",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_shadow=<VALUE>, selector=dict(type='densitymap'))"
},
"size": {
"editType": "colorbars",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_size=<VALUE>, selector=dict(type='densitymap'))"
},
"style": {
"description": "Sets whether a font should be styled with a normal or italic face from its family.",
@@ -77376,7 +67557,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_style=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77389,7 +67570,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_textcase=<VALUE>, selector=dict(type='densitymap'))"
},
"variant": {
"description": "Sets the variant of the font.",
@@ -77404,7 +67585,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_variant=<VALUE>, selector=dict(type='densitymap'))"
},
"weight": {
"description": "Sets the weight (or boldness) of the font.",
@@ -77417,13 +67598,13 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font_weight=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_font=dict(...), selector=dict(type='densitymap'))"
},
"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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -77431,21 +67612,21 @@
"top",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_side=<VALUE>, selector=dict(type='densitymap'))"
},
"text": {
"description": "Sets the title of the color bar.",
"editType": "colorbars",
"valType": "string",
- "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title_text=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_title=dict(...), selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_x=<VALUE>, selector=dict(type='densitymap'))"
},
"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*.",
@@ -77456,7 +67637,7 @@
"center",
"right"
],
- "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_xanchor=<VALUE>, selector=dict(type='densitymap'))"
},
"xpad": {
"description": "Sets the amount of padding (in px) along the x direction.",
@@ -77464,7 +67645,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_xpad=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77475,13 +67656,13 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_xref=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_y=<VALUE>, selector=dict(type='densitymap'))"
},
"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*.",
@@ -77492,7 +67673,7 @@
"middle",
"bottom"
],
- "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_yanchor=<VALUE>, selector=dict(type='densitymap'))"
},
"ypad": {
"description": "Sets the amount of padding (in px) along the y direction.",
@@ -77500,7 +67681,7 @@
"editType": "colorbars",
"min": 0,
"valType": "number",
- "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_ypad=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77511,54 +67692,54 @@
"container",
"paper"
],
- "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar_yref=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorbar=dict(...), selector=dict(type='densitymap'))"
},
"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": {
- "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(autocolorscale_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='densitymap'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
- "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorscale_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "colorscale",
- "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(colorscale=<VALUE>, selector=dict(type='densitymap'))"
},
"showscale": {
"description": "Determines whether or not a colorbar is displayed for this trace.",
"dflt": true,
"editType": "calc",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(showscale=<VALUE>, selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(reversescale=<VALUE>, selector=dict(type='densitymap'))"
},
"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": {
- "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(zauto_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "boolean",
- "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(zauto=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77566,20 +67747,20 @@
"editType": "calc",
"impliedEdits": {
"zauto": false,
- "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(zmax_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(zmax=<VALUE>, selector=dict(type='densitymap'))"
},
"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": {
- "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(zmid_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(zmid=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
@@ -77587,16 +67768,16 @@
"editType": "calc",
"impliedEdits": {
"zauto": false,
- "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(zmin_impliedEdits=<VALUE>, selector=dict(type='densitymap'))"
},
"valType": "number",
- "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(zmin=<VALUE>, selector=dict(type='densitymap'))"
},
"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.",
+ "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",
"valType": "string",
- "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(below=<VALUE>, selector=dict(type='densitymap'))"
},
"hoverlabel": {
"align": {
@@ -77610,36 +67791,21 @@
"right",
"auto"
],
- "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "alignsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `align`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='densitymap'))"
},
"bgcolor": {
"arrayOk": true,
"description": "Sets the background color of the hover labels for this trace",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "bgcolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='densitymap'))"
},
"bordercolor": {
"arrayOk": true,
"description": "Sets the border color of the hover labels for this trace.",
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='densitymap'))"
},
"editType": "none",
"font": {
@@ -77647,12 +67813,7 @@
"arrayOk": true,
"editType": "none",
"valType": "color",
- "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='densitymap'))"
},
"description": "Sets the font used in hover labels.",
"editType": "none",
@@ -77663,12 +67824,7 @@
"noBlank": true,
"strict": true,
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='densitymap'))"
},
"lineposition": {
"arrayOk": true,
@@ -77684,12 +67840,7 @@
"through"
],
"valType": "flaglist",
- "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='densitymap'))"
},
"role": "object",
"shadow": {
@@ -77698,24 +67849,14 @@
"dflt": "none",
"editType": "none",
"valType": "string",
- "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='densitymap'))"
},
"size": {
"arrayOk": true,
"editType": "none",
"min": 1,
"valType": "number",
- "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "sizesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `size`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='densitymap'))"
},
"style": {
"arrayOk": true,
@@ -77727,12 +67868,7 @@
"normal",
"italic"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "stylesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `style`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='densitymap'))"
},
"textcase": {
"arrayOk": true,
@@ -77746,12 +67882,7 @@
"upper",
"lower"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "textcasesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textcase`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='densitymap'))"
},
"variant": {
"arrayOk": true,
@@ -77767,12 +67898,7 @@
"petite-caps",
"unicase"
],
- "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "variantsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `variant`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='densitymap'))"
},
"weight": {
"arrayOk": true,
@@ -77786,14 +67912,9 @@
"max": 1000,
"min": 1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='densitymap'))"
},
"namelength": {
"arrayOk": true,
@@ -77802,12 +67923,7 @@
"editType": "none",
"min": -1,
"valType": "integer",
- "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
+ "magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='densitymap'))"
},
"role": "object",
"showarrow": {
@@ -77815,50 +67931,28 @@
"dflt": true,
"editType": "none",
"valType": "boolean",
- "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel_showarrow=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(hoverlabel=dict(...), selector=dict(type='densitymap'))"
},
"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",
- "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='densitymapbox'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='densitymap'))"
},
- "magic_underscores": "fig.update_traces(..., selector=dict(type='densitymapbox'))"
+ "magic_underscores": "fig.update_traces(..., selector=dict(type='densitymap'))"
},
"categories": [
- "mapbox",
+ "map",
"gl",
"showLegend"
],
"meta": {
- "description": "*densitymapbox* trace is deprecated! Please consider switching to the *densitymap* trace type and `map` subplots. Learn more at: https://plotly.com/python/maplibre-migration/ as well as 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"
+ "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": "densitymapbox"
+ "type": "densitymap"
},
"scatterpolar": {
"animatable": false,
@@ -78063,22 +68157,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"r": {
"description": "Sets the radial coordinates",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
"magic_underscores": "fig.update_traces(r=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "rsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `r`.",
- "editType": "none",
- "valType": "string"
- },
"r0": {
"description": "Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.",
"dflt": 0,
@@ -78099,11 +68183,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(theta=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "thetasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `theta`.",
- "editType": "none",
- "valType": "string"
- },
"theta0": {
"description": "Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.",
"dflt": 0,
@@ -78137,11 +68216,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"arrayOk": true,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
@@ -78161,11 +68235,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `r`, `theta` and `text`.",
@@ -78181,11 +68250,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -78194,14 +68258,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -78218,11 +68277,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -78238,11 +68292,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -78250,22 +68299,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
"subplot": {
"description": "Sets a reference between this trace's data coordinates and a polar subplot. If *polar* (the default value), the data refer to `layout.polar`. If *polar2*, the data refer to `layout.polar2`, and so on.",
"dflt": "polar",
@@ -78293,11 +68332,6 @@
],
"magic_underscores": "fig.update_traces(marker_angleref=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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,
@@ -78825,22 +68859,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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,
@@ -78952,7 +68976,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -79045,7 +69069,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scatterpolar'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -79055,11 +69079,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"gradient": {
"color": {
@@ -79069,11 +69088,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_gradient_color=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"type": {
@@ -79090,11 +69104,6 @@
],
"magic_underscores": "fig.update_traces(marker_gradient_type=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_gradient=dict(...), selector=dict(type='scatterpolar'))"
},
"line": {
@@ -79166,7 +69175,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scatterpolar'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -79176,11 +69185,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"dash": {
"arrayOk": true,
"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*).",
@@ -79197,11 +69201,6 @@
],
"magic_underscores": "fig.update_traces(marker_line_dash=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "dashsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `dash`.",
- "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.",
@@ -79219,11 +69218,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scatterpolar'))"
},
"maxdisplayed": {
@@ -79243,11 +69237,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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,
@@ -79298,11 +69287,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -79312,11 +69296,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_standoff=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -79813,11 +69792,6 @@
],
"magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scatterpolar'))"
},
"line": {
@@ -79830,11 +69804,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(line_backoff=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "backoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
- "editType": "none",
- "valType": "string"
- },
"color": {
"description": "Sets the line color.",
"editType": "style",
@@ -79895,11 +69864,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"description": "Sets the text font.",
"editType": "calc",
"family": {
@@ -79911,11 +69875,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -79932,11 +69891,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -79946,11 +69900,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -79958,11 +69907,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -79975,11 +69919,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -79994,11 +69933,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -80015,11 +69949,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -80034,11 +69963,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scatterpolar'))"
},
"selectedpoints": {
@@ -80177,11 +70101,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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",
@@ -80189,11 +70108,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -80201,11 +70115,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -80214,11 +70123,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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": {
@@ -80230,11 +70134,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -80251,11 +70150,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -80265,11 +70159,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -80277,11 +70166,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -80294,11 +70178,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -80313,11 +70192,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -80334,11 +70208,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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.",
@@ -80353,11 +70222,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scatterpolar'))"
},
"namelength": {
@@ -80369,11 +70233,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -80400,28 +70259,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scatterpolar'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scatterpolar'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scatterpolar'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scatterpolar'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='scatterpolar'))"
},
"categories": [
@@ -80639,22 +70476,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"r": {
"description": "Sets the radial coordinates",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
"magic_underscores": "fig.update_traces(r=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "rsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `r`.",
- "editType": "none",
- "valType": "string"
- },
"r0": {
"description": "Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.",
"dflt": 0,
@@ -80675,11 +70502,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(theta=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "thetasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `theta`.",
- "editType": "none",
- "valType": "string"
- },
"theta0": {
"description": "Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.",
"dflt": 0,
@@ -80713,11 +70535,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"arrayOk": true,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
@@ -80737,11 +70554,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `r`, `theta` and `text`.",
@@ -80757,11 +70569,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -80770,14 +70577,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -80794,11 +70596,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -80814,11 +70611,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -80826,22 +70618,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
"subplot": {
"description": "Sets a reference between this trace's data coordinates and a polar subplot. If *polar* (the default value), the data refer to `layout.polar`. If *polar2*, the data refer to `layout.polar2`, and so on.",
"dflt": "polar",
@@ -80858,11 +70640,6 @@
"valType": "angle",
"magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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,
@@ -81390,22 +71167,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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,
@@ -81517,7 +71284,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "calc",
"valType": "enumerated",
"values": [
@@ -81610,7 +71377,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scatterpolargl'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -81620,11 +71387,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"line": {
"autocolorscale": {
@@ -81695,7 +71457,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scatterpolargl'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -81705,11 +71467,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -81727,11 +71484,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scatterpolargl'))"
},
"opacity": {
@@ -81743,11 +71495,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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,
@@ -81798,11 +71545,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82299,11 +72041,6 @@
],
"magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scatterpolargl'))"
},
"line": {
@@ -82347,11 +72084,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"description": "Sets the text font.",
"editType": "calc",
"family": {
@@ -82363,11 +72095,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "familysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `family`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"size": {
"arrayOk": true,
@@ -82376,11 +72103,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82393,11 +72115,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82410,11 +72127,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82427,11 +72139,6 @@
],
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scatterpolargl'))"
},
"selectedpoints": {
@@ -82567,11 +72274,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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",
@@ -82579,11 +72281,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82591,11 +72288,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -82604,11 +72296,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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": {
@@ -82620,11 +72307,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82641,11 +72323,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -82655,11 +72332,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -82667,11 +72339,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82684,11 +72351,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82703,11 +72365,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82724,11 +72381,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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.",
@@ -82743,11 +72395,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scatterpolargl'))"
},
"namelength": {
@@ -82759,11 +72406,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -82780,28 +72422,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scatterpolargl'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scatterpolargl'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scatterpolargl'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scatterpolargl'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='scatterpolargl'))"
},
"categories": [
@@ -83007,11 +72627,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='barpolar'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"base": {
"arrayOk": true,
"description": "Sets where the bar base is drawn (in radial axis units). In *stack* barmode, traces that set *base* will be excluded and drawn in *overlay* mode instead.",
@@ -83020,22 +72635,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(base=<VALUE>, selector=dict(type='barpolar'))"
},
- "basesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `base`.",
- "editType": "none",
- "valType": "string"
- },
"r": {
"description": "Sets the radial coordinates",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
"magic_underscores": "fig.update_traces(r=<VALUE>, selector=dict(type='barpolar'))"
},
- "rsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `r`.",
- "editType": "none",
- "valType": "string"
- },
"r0": {
"description": "Alternate to `r`. Builds a linear space of r coordinates. Use with `dr` where `r0` is the starting coordinate and `dr` the step.",
"dflt": 0,
@@ -83056,11 +72661,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(theta=<VALUE>, selector=dict(type='barpolar'))"
},
- "thetasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `theta`.",
- "editType": "none",
- "valType": "string"
- },
"theta0": {
"description": "Alternate to `theta`. Builds a linear space of theta coordinates. Use with `dtheta` where `theta0` is the starting coordinate and `dtheta` the step.",
"dflt": 0,
@@ -83095,11 +72695,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(width=<VALUE>, selector=dict(type='barpolar'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"offset": {
"arrayOk": true,
"description": "Shifts the angular position where the bar is drawn (in *thetatunit* units).",
@@ -83108,11 +72703,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(offset=<VALUE>, selector=dict(type='barpolar'))"
},
- "offsetsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `offset`.",
- "editType": "none",
- "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.",
@@ -83121,11 +72711,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='barpolar'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"hovertext": {
"arrayOk": true,
"description": "Same as `text`.",
@@ -83134,14 +72719,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='barpolar'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -83158,11 +72738,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='barpolar'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -83178,11 +72753,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='barpolar'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -83190,22 +72760,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='barpolar'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='barpolar'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
"subplot": {
"description": "Sets a reference between this trace's data coordinates and a polar subplot. If *polar* (the default value), the data refer to `layout.polar`. If *polar2*, the data refer to `layout.polar2`, and so on.",
"dflt": "polar",
@@ -83741,22 +73301,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='barpolar'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='barpolar'))"
},
- "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,
@@ -83868,7 +73418,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -83961,7 +73511,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='barpolar'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -83971,11 +73521,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='barpolar'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"line": {
"autocolorscale": {
@@ -84046,7 +73591,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='barpolar'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -84056,11 +73601,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84079,11 +73619,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='barpolar'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='barpolar'))"
},
"opacity": {
@@ -84096,11 +73631,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='barpolar'))"
},
- "opacitysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `opacity`.",
- "editType": "none",
- "valType": "string"
- },
"pattern": {
"bgcolor": {
"arrayOk": true,
@@ -84109,11 +73639,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='barpolar'))"
},
- "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": {
@@ -84123,11 +73648,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='barpolar'))"
},
- "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",
@@ -84154,11 +73674,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='barpolar'))"
},
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shape": {
"arrayOk": true,
@@ -84178,11 +73693,6 @@
],
"magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84192,11 +73702,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84207,11 +73712,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='barpolar'))"
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='barpolar'))"
},
"reversescale": {
@@ -84321,11 +73821,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='barpolar'))"
},
- "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",
@@ -84333,11 +73828,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84345,11 +73835,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='barpolar'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -84358,11 +73843,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='barpolar'))"
},
- "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": {
@@ -84374,11 +73854,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84395,11 +73870,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='barpolar'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -84409,11 +73879,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='barpolar'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -84421,11 +73886,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84438,11 +73898,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84457,11 +73912,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84478,11 +73928,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='barpolar'))"
},
- "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.",
@@ -84497,11 +73942,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='barpolar'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='barpolar'))"
},
"namelength": {
@@ -84513,11 +73953,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='barpolar'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -84534,28 +73969,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='barpolar'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='barpolar'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='barpolar'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='barpolar'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='barpolar'))"
},
"categories": [
@@ -84793,57 +74206,32 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scatterternary'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"a": {
"description": "Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(a=<VALUE>, selector=dict(type='scatterternary'))"
},
- "asrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `a`.",
- "editType": "none",
- "valType": "string"
- },
"b": {
"description": "Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(b=<VALUE>, selector=dict(type='scatterternary'))"
},
- "bsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `b`.",
- "editType": "none",
- "valType": "string"
- },
"c": {
"description": "Sets the quantity of component `a` in each data point. If `a`, `b`, and `c` are all provided, they need not be normalized, only the relative values matter. If only two arrays are provided they must be normalized to match `ternary.sum`.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(c=<VALUE>, selector=dict(type='scatterternary'))"
},
- "csrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `c`.",
- "editType": "none",
- "valType": "string"
- },
"text": {
"arrayOk": true,
- "description": "Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
+ "description": "Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the data points in (a,b,c). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"dflt": "",
"editType": "calc",
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scatterternary'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"arrayOk": true,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
@@ -84863,11 +74251,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scatterternary'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`, `c` and `text`.",
@@ -84883,27 +74266,17 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scatterternary'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "editType": "none",
- "valType": "string"
- },
"hovertext": {
"arrayOk": true,
- "description": "Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a *text* flag.",
+ "description": "Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a *text* flag.",
"dflt": "",
"editType": "style",
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scatterternary'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -84921,11 +74294,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scatterternary'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -84941,11 +74309,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scatterternary'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -84953,22 +74316,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scatterternary'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scatterternary'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
"subplot": {
"description": "Sets a reference between this trace's data coordinates and a ternary subplot. If *ternary* (the default value), the data refer to `layout.ternary`. If *ternary2*, the data refer to `layout.ternary2`, and so on.",
"dflt": "ternary",
@@ -84996,11 +74349,6 @@
],
"magic_underscores": "fig.update_traces(marker_angleref=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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,
@@ -85528,22 +74876,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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,
@@ -85655,7 +74993,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -85748,7 +75086,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scatterternary'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -85758,11 +75096,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scatterternary'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"gradient": {
"color": {
@@ -85772,11 +75105,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_gradient_color=<VALUE>, selector=dict(type='scatterternary'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"type": {
@@ -85793,11 +75121,6 @@
],
"magic_underscores": "fig.update_traces(marker_gradient_type=<VALUE>, selector=dict(type='scatterternary'))"
},
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_gradient=dict(...), selector=dict(type='scatterternary'))"
},
"line": {
@@ -85869,7 +75192,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scatterternary'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -85879,11 +75202,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scatterternary'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"dash": {
"arrayOk": true,
"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*).",
@@ -85900,11 +75218,6 @@
],
"magic_underscores": "fig.update_traces(marker_line_dash=<VALUE>, selector=dict(type='scatterternary'))"
},
- "dashsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `dash`.",
- "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.",
@@ -85922,11 +75235,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scatterternary'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scatterternary'))"
},
"maxdisplayed": {
@@ -85946,11 +75254,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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,
@@ -86001,11 +75304,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86015,11 +75313,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_standoff=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86516,11 +75809,6 @@
],
"magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scatterternary'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scatterternary'))"
},
"line": {
@@ -86533,11 +75821,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(line_backoff=<VALUE>, selector=dict(type='scatterternary'))"
},
- "backoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
- "editType": "none",
- "valType": "string"
- },
"color": {
"description": "Sets the line color.",
"editType": "style",
@@ -86598,11 +75881,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scatterternary'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"description": "Sets the text font.",
"editType": "calc",
"family": {
@@ -86614,11 +75892,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86635,11 +75908,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='scatterternary'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -86649,11 +75917,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='scatterternary'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -86661,11 +75924,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86678,11 +75936,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86697,11 +75950,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86718,11 +75966,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86737,11 +75980,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scatterternary'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scatterternary'))"
},
"selectedpoints": {
@@ -86880,11 +76118,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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",
@@ -86892,11 +76125,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86904,11 +76132,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scatterternary'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -86917,11 +76140,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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": {
@@ -86933,11 +76151,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86954,11 +76167,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scatterternary'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -86968,11 +76176,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scatterternary'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -86980,11 +76183,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -86997,11 +76195,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -87016,11 +76209,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -87037,11 +76225,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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.",
@@ -87056,11 +76239,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scatterternary'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scatterternary'))"
},
"namelength": {
@@ -87072,11 +76250,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scatterternary'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -87111,28 +76284,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scatterternary'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scatterternary'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scatterternary'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scatterternary'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='scatterternary'))"
},
"categories": [
@@ -87350,33 +76501,18 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scattersmith'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"imag": {
"description": "Sets the imaginary component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
"magic_underscores": "fig.update_traces(imag=<VALUE>, selector=dict(type='scattersmith'))"
},
- "imagsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `imag`.",
- "editType": "none",
- "valType": "string"
- },
"real": {
"description": "Sets the real component of the data, in units of normalized impedance such that real=1, imag=0 is the center of the chart.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
"magic_underscores": "fig.update_traces(real=<VALUE>, selector=dict(type='scattersmith'))"
},
- "realsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `real`.",
- "editType": "none",
- "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.",
@@ -87385,11 +76521,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scattersmith'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"arrayOk": true,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
@@ -87409,11 +76540,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scattersmith'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `real`, `imag` and `text`.",
@@ -87429,11 +76555,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scattersmith'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -87442,14 +76563,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scattersmith'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -87466,11 +76582,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scattersmith'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -87486,11 +76597,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scattersmith'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -87498,22 +76604,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scattersmith'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scattersmith'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
"subplot": {
"description": "Sets a reference between this trace's data coordinates and a smith subplot. If *smith* (the default value), the data refer to `layout.smith`. If *smith2*, the data refer to `layout.smith2`, and so on.",
"dflt": "smith",
@@ -87541,11 +76637,6 @@
],
"magic_underscores": "fig.update_traces(marker_angleref=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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,
@@ -88073,22 +77164,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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,
@@ -88200,7 +77281,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -88293,7 +77374,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scattersmith'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -88303,11 +77384,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scattersmith'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"gradient": {
"color": {
@@ -88317,11 +77393,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_gradient_color=<VALUE>, selector=dict(type='scattersmith'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"type": {
@@ -88338,11 +77409,6 @@
],
"magic_underscores": "fig.update_traces(marker_gradient_type=<VALUE>, selector=dict(type='scattersmith'))"
},
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_gradient=dict(...), selector=dict(type='scattersmith'))"
},
"line": {
@@ -88414,7 +77480,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scattersmith'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -88424,11 +77490,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scattersmith'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"dash": {
"arrayOk": true,
"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*).",
@@ -88445,11 +77506,6 @@
],
"magic_underscores": "fig.update_traces(marker_line_dash=<VALUE>, selector=dict(type='scattersmith'))"
},
- "dashsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `dash`.",
- "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.",
@@ -88467,11 +77523,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scattersmith'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scattersmith'))"
},
"maxdisplayed": {
@@ -88491,11 +77542,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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,
@@ -88546,11 +77592,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -88560,11 +77601,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_standoff=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89061,11 +78097,6 @@
],
"magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scattersmith'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scattersmith'))"
},
"line": {
@@ -89078,11 +78109,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(line_backoff=<VALUE>, selector=dict(type='scattersmith'))"
},
- "backoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
- "editType": "none",
- "valType": "string"
- },
"color": {
"description": "Sets the line color.",
"editType": "style",
@@ -89143,11 +78169,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scattersmith'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"description": "Sets the text font.",
"editType": "calc",
"family": {
@@ -89159,11 +78180,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89180,11 +78196,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='scattersmith'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -89194,11 +78205,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='scattersmith'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -89206,11 +78212,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89223,11 +78224,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89242,11 +78238,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89263,11 +78254,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89282,11 +78268,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scattersmith'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scattersmith'))"
},
"selectedpoints": {
@@ -89425,11 +78406,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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",
@@ -89437,11 +78413,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89449,11 +78420,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scattersmith'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -89462,11 +78428,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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": {
@@ -89478,11 +78439,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89499,11 +78455,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scattersmith'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -89513,11 +78464,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scattersmith'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -89525,11 +78471,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89542,11 +78483,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89561,11 +78497,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89582,11 +78513,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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.",
@@ -89601,11 +78527,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scattersmith'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scattersmith'))"
},
"namelength": {
@@ -89617,11 +78538,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scattersmith'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -89648,28 +78564,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scattersmith'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scattersmith'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scattersmith'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scattersmith'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='scattersmith'))"
},
"categories": [
@@ -89861,55 +78755,30 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='sunburst'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
"magic_underscores": "fig.update_traces(parents=<VALUE>, selector=dict(type='sunburst'))"
},
- "parentssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `parents`.",
- "editType": "none",
- "valType": "string"
- },
"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",
"magic_underscores": "fig.update_traces(values=<VALUE>, selector=dict(type='sunburst'))"
},
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
"labels": {
"description": "Sets the labels of each of the sectors.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(labels=<VALUE>, selector=dict(type='sunburst'))"
},
- "labelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
- "editType": "none",
- "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",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='sunburst'))"
},
- "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 appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`.",
@@ -89925,11 +78794,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='sunburst'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -89938,14 +78802,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='sunburst'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. Flags are rendered in a fixed order; use `hovertemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"dflt": "label+text+value+name",
"editType": "none",
"extras": [
@@ -89966,11 +78825,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='sunburst'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -89986,11 +78840,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='sunburst'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -89998,25 +78847,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='sunburst'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='sunburst'))"
},
- "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 sunburst trace .",
+ "description": "If there is a layout grid, use the domain for this column in the grid for this sunburst trace.",
"dflt": 0,
"editType": "calc",
"min": 0,
@@ -90026,7 +78865,7 @@
"editType": "calc",
"role": "object",
"row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this sunburst trace .",
+ "description": "If there is a layout grid, use the domain for this row in the grid for this sunburst trace.",
"dflt": 0,
"editType": "calc",
"min": 0,
@@ -90604,22 +79443,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='sunburst'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='sunburst'))"
},
- "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,
@@ -90731,7 +79560,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -90830,7 +79659,7 @@
"magic_underscores": "fig.update_traces(marker_colors=<VALUE>, selector=dict(type='sunburst'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -90840,11 +79669,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='sunburst'))"
},
- "colorssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"line": {
"color": {
@@ -90855,11 +79679,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='sunburst'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"width": {
@@ -90871,11 +79690,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='sunburst'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='sunburst'))"
},
"pattern": {
@@ -90886,11 +79700,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='sunburst'))"
},
- "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": {
@@ -90900,11 +79709,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='sunburst'))"
},
- "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",
@@ -90931,11 +79735,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='sunburst'))"
},
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shape": {
"arrayOk": true,
@@ -90955,11 +79754,6 @@
],
"magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -90969,11 +79763,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -90984,11 +79773,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='sunburst'))"
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='sunburst'))"
},
"reversescale": {
@@ -91015,11 +79799,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='sunburst'))"
},
- "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": {
@@ -91031,11 +79810,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91052,11 +79826,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='sunburst'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -91066,11 +79835,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='sunburst'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -91078,11 +79842,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91095,11 +79854,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91114,11 +79868,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91135,11 +79884,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91154,15 +79898,10 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='sunburst'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='sunburst'))"
},
"textinfo": {
- "description": "Determines which trace information appear on the graph.",
+ "description": "Determines what trace information appears on the graph. Flags are rendered in a fixed order; use `texttemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"editType": "plot",
"extras": [
"none"
@@ -91215,11 +79954,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='sunburst'))"
},
- "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",
@@ -91227,11 +79961,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91239,11 +79968,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='sunburst'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -91252,11 +79976,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='sunburst'))"
},
- "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": {
@@ -91268,11 +79987,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91289,11 +80003,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='sunburst'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -91303,11 +80012,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='sunburst'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -91315,11 +80019,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91332,11 +80031,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91351,11 +80045,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91372,11 +80061,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91391,11 +80075,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='sunburst'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='sunburst'))"
},
"namelength": {
@@ -91407,11 +80086,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='sunburst'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -91429,11 +80103,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='sunburst'))"
},
- "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": {
@@ -91445,11 +80114,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91466,11 +80130,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='sunburst'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -91480,11 +80139,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='sunburst'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -91492,11 +80146,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91509,11 +80158,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91528,11 +80172,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91549,11 +80188,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91568,11 +80202,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='sunburst'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='sunburst'))"
},
"insidetextorientation": {
@@ -91595,11 +80224,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='sunburst'))"
},
- "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 at the center of a sunburst 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": {
@@ -91611,11 +80235,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91632,11 +80251,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='sunburst'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -91646,11 +80260,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='sunburst'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -91658,11 +80267,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91675,11 +80279,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91694,11 +80293,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91715,11 +80309,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='sunburst'))"
},
- "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.",
@@ -91734,11 +80323,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='sunburst'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='sunburst'))"
},
"root": {
@@ -91800,28 +80384,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='sunburst'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='sunburst'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='sunburst'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='sunburst'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='sunburst'))"
},
"categories": [],
@@ -92020,55 +80582,30 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='treemap'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
"magic_underscores": "fig.update_traces(parents=<VALUE>, selector=dict(type='treemap'))"
},
- "parentssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `parents`.",
- "editType": "none",
- "valType": "string"
- },
"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",
"magic_underscores": "fig.update_traces(values=<VALUE>, selector=dict(type='treemap'))"
},
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
"labels": {
"description": "Sets the labels of each of the sectors.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(labels=<VALUE>, selector=dict(type='treemap'))"
},
- "labelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
- "editType": "none",
- "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",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='treemap'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"description": "Sets the positions of the `text` elements.",
"dflt": "top left",
@@ -92102,11 +80639,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='treemap'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -92115,14 +80647,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='treemap'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. Flags are rendered in a fixed order; use `hovertemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"dflt": "label+text+value+name",
"editType": "none",
"extras": [
@@ -92143,11 +80670,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='treemap'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -92163,11 +80685,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='treemap'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -92175,25 +80692,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='treemap'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='treemap'))"
},
- "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 treemap trace .",
+ "description": "If there is a layout grid, use the domain for this column in the grid for this treemap trace.",
"dflt": 0,
"editType": "calc",
"min": 0,
@@ -92203,7 +80710,7 @@
"editType": "calc",
"role": "object",
"row": {
- "description": "If there is a layout grid, use the domain for this row in the grid for this treemap trace .",
+ "description": "If there is a layout grid, use the domain for this row in the grid for this treemap trace.",
"dflt": 0,
"editType": "calc",
"min": 0,
@@ -92781,22 +81288,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='treemap'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='treemap'))"
},
- "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,
@@ -92908,7 +81405,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -93007,7 +81504,7 @@
"magic_underscores": "fig.update_traces(marker_colors=<VALUE>, selector=dict(type='treemap'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -93017,11 +81514,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='treemap'))"
},
- "colorssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
- "editType": "none",
- "valType": "string"
- },
"cornerradius": {
"description": "Sets the maximum rounding of corners (in px).",
"dflt": 0,
@@ -93051,11 +81543,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='treemap'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"width": {
@@ -93067,11 +81554,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='treemap'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='treemap'))"
},
"pad": {
@@ -93115,11 +81597,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='treemap'))"
},
- "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": {
@@ -93129,11 +81606,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='treemap'))"
},
- "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",
@@ -93160,11 +81632,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='treemap'))"
},
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shape": {
"arrayOk": true,
@@ -93184,11 +81651,6 @@
],
"magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93198,11 +81660,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93213,11 +81670,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='treemap'))"
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='treemap'))"
},
"reversescale": {
@@ -93244,11 +81696,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='treemap'))"
},
- "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": {
@@ -93260,11 +81707,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93281,11 +81723,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='treemap'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -93295,11 +81732,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='treemap'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -93307,11 +81739,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93324,11 +81751,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93343,11 +81765,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93364,11 +81781,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93383,15 +81795,10 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='treemap'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='treemap'))"
},
"textinfo": {
- "description": "Determines which trace information appear on the graph.",
+ "description": "Determines what trace information appears on the graph. Flags are rendered in a fixed order; use `texttemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"editType": "plot",
"extras": [
"none"
@@ -93495,7 +81902,7 @@
"editType": "calc",
"role": "object",
"side": {
- "description": "Determines on which side of the the treemap the `pathbar` should be presented.",
+ "description": "Determines on which side of the treemap the `pathbar` should be presented.",
"dflt": "top",
"editType": "plot",
"valType": "enumerated",
@@ -93512,11 +81919,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(pathbar_textfont_color=<VALUE>, selector=dict(type='treemap'))"
},
- "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",
"family": {
@@ -93528,11 +81930,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(pathbar_textfont_family=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93549,11 +81946,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(pathbar_textfont_lineposition=<VALUE>, selector=dict(type='treemap'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -93563,11 +81955,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(pathbar_textfont_shadow=<VALUE>, selector=dict(type='treemap'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -93575,11 +81962,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(pathbar_textfont_size=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93592,11 +81974,6 @@
],
"magic_underscores": "fig.update_traces(pathbar_textfont_style=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93611,11 +81988,6 @@
],
"magic_underscores": "fig.update_traces(pathbar_textfont_textcase=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93632,11 +82004,6 @@
],
"magic_underscores": "fig.update_traces(pathbar_textfont_variant=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93651,11 +82018,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(pathbar_textfont_weight=<VALUE>, selector=dict(type='treemap'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(pathbar_textfont=dict(...), selector=dict(type='treemap'))"
},
"thickness": {
@@ -93688,11 +82050,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='treemap'))"
},
- "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",
@@ -93700,11 +82057,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93712,11 +82064,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='treemap'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -93725,11 +82072,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='treemap'))"
},
- "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": {
@@ -93741,11 +82083,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93762,11 +82099,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='treemap'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -93776,11 +82108,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='treemap'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -93788,11 +82115,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93805,11 +82127,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93824,11 +82141,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93845,11 +82157,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93864,11 +82171,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='treemap'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='treemap'))"
},
"namelength": {
@@ -93880,11 +82182,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='treemap'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -93902,11 +82199,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='treemap'))"
},
- "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": {
@@ -93918,11 +82210,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93939,11 +82226,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='treemap'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -93953,11 +82235,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='treemap'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -93965,11 +82242,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -93982,11 +82254,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -94001,11 +82268,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -94022,11 +82284,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -94041,11 +82298,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='treemap'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='treemap'))"
},
"outsidetextfont": {
@@ -94055,11 +82307,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='treemap'))"
},
- "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": {
@@ -94071,11 +82318,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -94092,11 +82334,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='treemap'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -94106,11 +82343,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='treemap'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -94118,11 +82350,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -94135,11 +82362,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -94154,11 +82376,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -94175,11 +82392,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='treemap'))"
},
- "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.",
@@ -94194,11 +82406,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='treemap'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='treemap'))"
},
"root": {
@@ -94240,28 +82447,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='treemap'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='treemap'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='treemap'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='treemap'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='treemap'))"
},
"categories": [],
@@ -94460,55 +82645,30 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='icicle'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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",
"magic_underscores": "fig.update_traces(parents=<VALUE>, selector=dict(type='icicle'))"
},
- "parentssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `parents`.",
- "editType": "none",
- "valType": "string"
- },
"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",
"magic_underscores": "fig.update_traces(values=<VALUE>, selector=dict(type='icicle'))"
},
- "valuessrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `values`.",
- "editType": "none",
- "valType": "string"
- },
"labels": {
"description": "Sets the labels of each of the sectors.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(labels=<VALUE>, selector=dict(type='icicle'))"
},
- "labelssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `labels`.",
- "editType": "none",
- "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",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='icicle'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"description": "Sets the positions of the `text` elements.",
"dflt": "top left",
@@ -94542,11 +82702,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='icicle'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
@@ -94555,14 +82710,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='icicle'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. Flags are rendered in a fixed order; use `hovertemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"dflt": "label+text+value+name",
"editType": "none",
"extras": [
@@ -94583,11 +82733,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='icicle'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -94603,11 +82748,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='icicle'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -94615,25 +82755,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='icicle'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='icicle'))"
},
- "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 .",
+ "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,
@@ -94643,7 +82773,7 @@
"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 .",
+ "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,
@@ -95221,22 +83351,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='icicle'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='icicle'))"
},
- "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,
@@ -95348,7 +83468,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -95447,7 +83567,7 @@
"magic_underscores": "fig.update_traces(marker_colors=<VALUE>, selector=dict(type='icicle'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -95457,11 +83577,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='icicle'))"
},
- "colorssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `colors`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"line": {
"color": {
@@ -95472,11 +83587,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_line_color=<VALUE>, selector=dict(type='icicle'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"width": {
@@ -95488,11 +83598,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='icicle'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='icicle'))"
},
"pattern": {
@@ -95503,11 +83608,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_bgcolor=<VALUE>, selector=dict(type='icicle'))"
},
- "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": {
@@ -95517,11 +83617,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_pattern_fgcolor=<VALUE>, selector=dict(type='icicle'))"
},
- "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",
@@ -95548,11 +83643,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(marker_pattern_path=<VALUE>, selector=dict(type='icicle'))"
},
- "pathsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `path`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shape": {
"arrayOk": true,
@@ -95572,11 +83662,6 @@
],
"magic_underscores": "fig.update_traces(marker_pattern_shape=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95586,11 +83671,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_size=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95601,11 +83681,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_pattern_solidity=<VALUE>, selector=dict(type='icicle'))"
},
- "soliditysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_pattern=dict(...), selector=dict(type='icicle'))"
},
"reversescale": {
@@ -95632,11 +83707,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='icicle'))"
},
- "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": {
@@ -95648,11 +83718,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95669,11 +83734,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='icicle'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -95683,11 +83743,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='icicle'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -95695,11 +83750,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95712,11 +83762,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95731,11 +83776,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95752,11 +83792,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95771,15 +83806,10 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='icicle'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='icicle'))"
},
"textinfo": {
- "description": "Determines which trace information appear on the graph.",
+ "description": "Determines what trace information appears on the graph. Flags are rendered in a fixed order; use `texttemplate` if you need explicit control over the rendered string, including the order of fields and surrounding text.",
"editType": "plot",
"extras": [
"none"
@@ -95871,7 +83901,7 @@
"editType": "calc",
"role": "object",
"side": {
- "description": "Determines on which side of the the treemap the `pathbar` should be presented.",
+ "description": "Determines on which side of the treemap the `pathbar` should be presented.",
"dflt": "top",
"editType": "plot",
"valType": "enumerated",
@@ -95888,11 +83918,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(pathbar_textfont_color=<VALUE>, selector=dict(type='icicle'))"
},
- "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",
"family": {
@@ -95904,11 +83929,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(pathbar_textfont_family=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95925,11 +83945,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(pathbar_textfont_lineposition=<VALUE>, selector=dict(type='icicle'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -95939,11 +83954,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(pathbar_textfont_shadow=<VALUE>, selector=dict(type='icicle'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -95951,11 +83961,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(pathbar_textfont_size=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95968,11 +83973,6 @@
],
"magic_underscores": "fig.update_traces(pathbar_textfont_style=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -95987,11 +83987,6 @@
],
"magic_underscores": "fig.update_traces(pathbar_textfont_textcase=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96008,11 +84003,6 @@
],
"magic_underscores": "fig.update_traces(pathbar_textfont_variant=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96027,11 +84017,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(pathbar_textfont_weight=<VALUE>, selector=dict(type='icicle'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(pathbar_textfont=dict(...), selector=dict(type='icicle'))"
},
"thickness": {
@@ -96064,11 +84049,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='icicle'))"
},
- "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",
@@ -96076,11 +84056,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96088,11 +84063,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='icicle'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -96101,11 +84071,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='icicle'))"
},
- "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": {
@@ -96117,11 +84082,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96138,11 +84098,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='icicle'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -96152,11 +84107,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='icicle'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -96164,11 +84114,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96181,11 +84126,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96200,11 +84140,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96221,11 +84156,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96240,11 +84170,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='icicle'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='icicle'))"
},
"namelength": {
@@ -96256,11 +84181,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='icicle'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -96278,11 +84198,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(insidetextfont_color=<VALUE>, selector=dict(type='icicle'))"
},
- "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": {
@@ -96294,11 +84209,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_family=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96315,11 +84225,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(insidetextfont_lineposition=<VALUE>, selector=dict(type='icicle'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -96329,11 +84234,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(insidetextfont_shadow=<VALUE>, selector=dict(type='icicle'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -96341,11 +84241,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(insidetextfont_size=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96358,11 +84253,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_style=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96377,11 +84267,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_textcase=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96398,11 +84283,6 @@
],
"magic_underscores": "fig.update_traces(insidetextfont_variant=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96417,11 +84297,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(insidetextfont_weight=<VALUE>, selector=dict(type='icicle'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(insidetextfont=dict(...), selector=dict(type='icicle'))"
},
"outsidetextfont": {
@@ -96431,11 +84306,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(outsidetextfont_color=<VALUE>, selector=dict(type='icicle'))"
},
- "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": {
@@ -96447,11 +84317,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_family=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96468,11 +84333,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(outsidetextfont_lineposition=<VALUE>, selector=dict(type='icicle'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -96482,11 +84342,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(outsidetextfont_shadow=<VALUE>, selector=dict(type='icicle'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "plot",
@@ -96494,11 +84349,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(outsidetextfont_size=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96511,11 +84361,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_style=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96530,11 +84375,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_textcase=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96551,11 +84391,6 @@
],
"magic_underscores": "fig.update_traces(outsidetextfont_variant=<VALUE>, selector=dict(type='icicle'))"
},
- "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.",
@@ -96570,11 +84405,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(outsidetextfont_weight=<VALUE>, selector=dict(type='icicle'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(outsidetextfont=dict(...), selector=dict(type='icicle'))"
},
"root": {
@@ -96629,28 +84459,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='icicle'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='icicle'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='icicle'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='icicle'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='icicle'))"
},
"categories": [],
@@ -96838,14 +84646,9 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='sankey'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -96864,25 +84667,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='sankey'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='sankey'))"
},
- "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 .",
+ "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,
@@ -96892,7 +84685,7 @@
"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 .",
+ "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,
@@ -96981,22 +84774,12 @@
"valType": "color",
"magic_underscores": "fig.update_traces(node_color=<VALUE>, selector=dict(type='sankey'))"
},
- "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",
"magic_underscores": "fig.update_traces(node_customdata=<VALUE>, selector=dict(type='sankey'))"
},
- "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": {
@@ -97017,7 +84800,7 @@
"magic_underscores": "fig.update_traces(node_groups=list(...), selector=dict(type='sankey'))"
},
"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.",
+ "description": "Determines what trace information appears 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",
@@ -97042,11 +84825,6 @@
],
"magic_underscores": "fig.update_traces(node_hoverlabel_align=<VALUE>, selector=dict(type='sankey'))"
},
- "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",
@@ -97054,11 +84832,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(node_hoverlabel_bgcolor=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97066,11 +84839,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(node_hoverlabel_bordercolor=<VALUE>, selector=dict(type='sankey'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"font": {
"color": {
@@ -97079,11 +84847,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(node_hoverlabel_font_color=<VALUE>, selector=dict(type='sankey'))"
},
- "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": {
@@ -97095,11 +84858,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(node_hoverlabel_font_family=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97116,11 +84874,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(node_hoverlabel_font_lineposition=<VALUE>, selector=dict(type='sankey'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -97130,11 +84883,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(node_hoverlabel_font_shadow=<VALUE>, selector=dict(type='sankey'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -97142,11 +84890,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(node_hoverlabel_font_size=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97159,11 +84902,6 @@
],
"magic_underscores": "fig.update_traces(node_hoverlabel_font_style=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97178,11 +84916,6 @@
],
"magic_underscores": "fig.update_traces(node_hoverlabel_font_textcase=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97199,11 +84932,6 @@
],
"magic_underscores": "fig.update_traces(node_hoverlabel_font_variant=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97218,11 +84946,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(node_hoverlabel_font_weight=<VALUE>, selector=dict(type='sankey'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(node_hoverlabel_font=dict(...), selector=dict(type='sankey'))"
},
"namelength": {
@@ -97234,11 +84957,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(node_hoverlabel_namelength=<VALUE>, selector=dict(type='sankey'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -97264,11 +84982,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(node_hovertemplatefallback=<VALUE>, selector=dict(type='sankey'))"
},
- "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": [],
@@ -97276,11 +84989,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(node_label=<VALUE>, selector=dict(type='sankey'))"
},
- "labelsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `label`.",
- "editType": "none",
- "valType": "string"
- },
"line": {
"color": {
"arrayOk": true,
@@ -97290,11 +84998,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(node_line_color=<VALUE>, selector=dict(type='sankey'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"width": {
@@ -97306,11 +85009,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(node_line_width=<VALUE>, selector=dict(type='sankey'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(node_line=dict(...), selector=dict(type='sankey'))"
},
"pad": {
@@ -97323,6 +85021,17 @@
"magic_underscores": "fig.update_traces(node_pad=<VALUE>, selector=dict(type='sankey'))"
},
"role": "object",
+ "sort": {
+ "description": "For `auto` (the default), the vertical order of nodes will be determined automatically by the layout. For `input`, the vertical order of nodes is kept the same as the order in the input array.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "input"
+ ],
+ "magic_underscores": "fig.update_traces(node_sort=<VALUE>, selector=dict(type='sankey'))"
+ },
"thickness": {
"arrayOk": false,
"description": "Sets the thickness (in px) of the `nodes`.",
@@ -97339,11 +85048,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(node_x=<VALUE>, selector=dict(type='sankey'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
"y": {
"description": "The normalized vertical position of the node.",
"dflt": [],
@@ -97351,11 +85055,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(node_y=<VALUE>, selector=dict(type='sankey'))"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(node=dict(...), selector=dict(type='sankey'))"
},
"link": {
@@ -97390,7 +85089,7 @@
"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.",
+ "description": "Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
@@ -97430,22 +85129,12 @@
"role": "object",
"magic_underscores": "fig.update_traces(link_colorscales=list(...), selector=dict(type='sankey'))"
},
- "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",
"magic_underscores": "fig.update_traces(link_customdata=<VALUE>, selector=dict(type='sankey'))"
},
- "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": {
@@ -97455,13 +85144,8 @@
"valType": "color",
"magic_underscores": "fig.update_traces(link_hovercolor=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
+ "description": "Determines what trace information appears 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",
@@ -97486,11 +85170,6 @@
],
"magic_underscores": "fig.update_traces(link_hoverlabel_align=<VALUE>, selector=dict(type='sankey'))"
},
- "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",
@@ -97498,11 +85177,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(link_hoverlabel_bgcolor=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97510,11 +85184,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(link_hoverlabel_bordercolor=<VALUE>, selector=dict(type='sankey'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"font": {
"color": {
@@ -97523,11 +85192,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(link_hoverlabel_font_color=<VALUE>, selector=dict(type='sankey'))"
},
- "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": {
@@ -97539,11 +85203,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(link_hoverlabel_font_family=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97560,11 +85219,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(link_hoverlabel_font_lineposition=<VALUE>, selector=dict(type='sankey'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -97574,11 +85228,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(link_hoverlabel_font_shadow=<VALUE>, selector=dict(type='sankey'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -97586,11 +85235,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(link_hoverlabel_font_size=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97603,11 +85247,6 @@
],
"magic_underscores": "fig.update_traces(link_hoverlabel_font_style=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97622,11 +85261,6 @@
],
"magic_underscores": "fig.update_traces(link_hoverlabel_font_textcase=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97643,11 +85277,6 @@
],
"magic_underscores": "fig.update_traces(link_hoverlabel_font_variant=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97662,11 +85291,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(link_hoverlabel_font_weight=<VALUE>, selector=dict(type='sankey'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(link_hoverlabel_font=dict(...), selector=dict(type='sankey'))"
},
"namelength": {
@@ -97678,11 +85302,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(link_hoverlabel_namelength=<VALUE>, selector=dict(type='sankey'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -97708,11 +85327,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(link_hovertemplatefallback=<VALUE>, selector=dict(type='sankey'))"
},
- "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": [],
@@ -97720,11 +85334,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(link_label=<VALUE>, selector=dict(type='sankey'))"
},
- "labelsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `label`.",
- "editType": "none",
- "valType": "string"
- },
"line": {
"color": {
"arrayOk": true,
@@ -97734,11 +85343,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(link_line_color=<VALUE>, selector=dict(type='sankey'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"width": {
@@ -97750,14 +85354,20 @@
"valType": "number",
"magic_underscores": "fig.update_traces(link_line_width=<VALUE>, selector=dict(type='sankey'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(link_line=dict(...), selector=dict(type='sankey'))"
},
"role": "object",
+ "sort": {
+ "description": "For `auto` (the default), the order of links attached to each node is determined automatically by the layout. For `input`, the order of links at each node is kept the same as the order in the input array.",
+ "dflt": "auto",
+ "editType": "calc",
+ "valType": "enumerated",
+ "values": [
+ "auto",
+ "input"
+ ],
+ "magic_underscores": "fig.update_traces(link_sort=<VALUE>, selector=dict(type='sankey'))"
+ },
"source": {
"description": "An integer number `[0..nodes.length - 1]` that represents the source node.",
"dflt": [],
@@ -97765,11 +85375,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(link_source=<VALUE>, selector=dict(type='sankey'))"
},
- "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": [],
@@ -97777,11 +85382,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(link_target=<VALUE>, selector=dict(type='sankey'))"
},
- "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": [],
@@ -97789,11 +85389,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(link_value=<VALUE>, selector=dict(type='sankey'))"
},
- "valuesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `value`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(link=dict(...), selector=dict(type='sankey'))"
},
"textfont": {
@@ -97928,11 +85523,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='sankey'))"
},
- "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",
@@ -97940,11 +85530,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -97952,11 +85537,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='sankey'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"font": {
"color": {
@@ -97965,11 +85545,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='sankey'))"
},
- "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": {
@@ -97981,11 +85556,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -98002,11 +85572,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='sankey'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -98016,11 +85581,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='sankey'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -98028,11 +85588,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -98045,11 +85600,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -98064,11 +85614,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -98085,11 +85630,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='sankey'))"
},
- "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.",
@@ -98104,11 +85644,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='sankey'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='sankey'))"
},
"namelength": {
@@ -98120,11 +85655,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='sankey'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -98155,28 +85685,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='sankey'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='sankey'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='sankey'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='sankey'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='sankey'))"
},
"categories": [
@@ -98376,11 +85884,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='splom'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"text": {
"arrayOk": true,
"description": "Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.",
@@ -98389,11 +85892,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='splom'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"dimensions": {
"items": {
"dimension": {
@@ -98401,7 +85899,7 @@
"editType": "calc+clearAxisTypes",
"matches": {
"description": "Determines whether or not the x & y axes generated by this dimension match. Equivalent to setting the `matches` axis attribute in the layout with the correct axis id.",
- "dflt": false,
+ "dflt": true,
"editType": "calc",
"valType": "boolean"
},
@@ -98440,11 +85938,6 @@
"editType": "calc+clearAxisTypes",
"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 dimension is shown on the graph. Note that even visible false dimension contribute to the default grid generate by this splom trace.",
"dflt": true,
@@ -98464,14 +85957,9 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='splom'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -98489,11 +85977,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='splom'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -98509,20 +85992,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='splom'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "editType": "none",
- "valType": "string"
- },
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
"magic_underscores": "fig.update_traces(xhoverformat=<VALUE>, selector=dict(type='splom'))"
},
"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`.",
+ "description": "Sets the hover text formatting rule for `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",
@@ -98535,22 +86013,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='splom'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='splom'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
"marker": {
"angle": {
"arrayOk": true,
@@ -98560,11 +86028,6 @@
"valType": "angle",
"magic_underscores": "fig.update_traces(marker_angle=<VALUE>, selector=dict(type='splom'))"
},
- "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,
@@ -99092,22 +86555,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='splom'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='splom'))"
},
- "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,
@@ -99219,7 +86672,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -99312,7 +86765,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='splom'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -99322,11 +86775,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='splom'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"line": {
"autocolorscale": {
@@ -99397,7 +86845,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='splom'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -99407,11 +86855,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='splom'))"
},
- "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.",
@@ -99429,11 +86872,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='splom'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='splom'))"
},
"opacity": {
@@ -99445,11 +86883,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='splom'))"
},
- "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,
@@ -99500,11 +86933,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='splom'))"
},
- "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.",
@@ -100001,11 +87429,6 @@
],
"magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='splom'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='splom'))"
},
"diagonal": {
@@ -100140,11 +87563,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='splom'))"
},
- "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",
@@ -100152,11 +87570,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='splom'))"
},
- "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.",
@@ -100164,11 +87577,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='splom'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -100177,11 +87585,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='splom'))"
},
- "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": {
@@ -100193,11 +87596,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='splom'))"
},
- "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.",
@@ -100214,11 +87612,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='splom'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -100228,11 +87621,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='splom'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -100240,11 +87628,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='splom'))"
},
- "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.",
@@ -100257,11 +87640,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='splom'))"
},
- "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.",
@@ -100276,11 +87654,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='splom'))"
},
- "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.",
@@ -100297,11 +87670,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='splom'))"
},
- "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.",
@@ -100316,11 +87684,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='splom'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='splom'))"
},
"namelength": {
@@ -100332,11 +87695,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='splom'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -100353,28 +87711,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='splom'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='splom'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='splom'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='splom'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='splom'))"
},
"categories": [
@@ -100556,11 +87892,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='parcoords'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "editType": "none",
- "valType": "string"
- },
"dimensions": {
"items": {
"dimension": {
@@ -100631,31 +87962,16 @@
"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,
@@ -100674,25 +87990,15 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='parcoords'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='parcoords'))"
},
- "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 parcoords trace .",
+ "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,
@@ -100702,7 +88008,7 @@
"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 .",
+ "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,
@@ -101287,22 +88593,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(line_colorbar_ticktext=<VALUE>, selector=dict(type='parcoords'))"
},
- "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",
"magic_underscores": "fig.update_traces(line_colorbar_tickvals=<VALUE>, selector=dict(type='parcoords'))"
},
- "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,
@@ -101414,7 +88710,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -101507,7 +88803,7 @@
"magic_underscores": "fig.update_traces(line_colorbar=dict(...), selector=dict(type='parcoords'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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,
@@ -101586,11 +88882,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(line_colorscale=<VALUE>, selector=dict(type='parcoords'))"
},
- "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.",
@@ -101956,28 +89247,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='parcoords'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='parcoords'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='parcoords'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='parcoords'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='parcoords'))"
},
"categories": [
@@ -102146,11 +89415,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(counts=<VALUE>, selector=dict(type='parcats'))"
},
- "countssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `counts`.",
- "editType": "none",
- "valType": "string"
- },
"dimensions": {
"items": {
"dimension": {
@@ -102159,11 +89423,6 @@
"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",
@@ -102194,22 +89453,12 @@
"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,
@@ -102223,7 +89472,7 @@
},
"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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -102259,14 +89508,9 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='parcats'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "editType": "none",
- "valType": "string"
- },
"domain": {
"column": {
- "description": "If there is a layout grid, use the domain for this column in the grid for this parcats trace .",
+ "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,
@@ -102276,7 +89520,7 @@
"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 .",
+ "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,
@@ -102861,22 +90105,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(line_colorbar_ticktext=<VALUE>, selector=dict(type='parcats'))"
},
- "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",
"magic_underscores": "fig.update_traces(line_colorbar_tickvals=<VALUE>, selector=dict(type='parcats'))"
},
- "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,
@@ -102988,7 +90222,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -103081,7 +90315,7 @@
"magic_underscores": "fig.update_traces(line_colorbar=dict(...), selector=dict(type='parcats'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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": {
@@ -103091,11 +90325,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(line_colorscale=<VALUE>, selector=dict(type='parcats'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. 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 ``.",
@@ -103385,28 +90614,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='parcats'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='parcats'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='parcats'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='parcats'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='parcats'))"
},
"categories": [
@@ -103594,11 +90801,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='carpet'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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,
@@ -103612,33 +90814,18 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(x=<VALUE>, selector=dict(type='carpet'))"
},
- "xsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `x`.",
- "editType": "none",
- "valType": "string"
- },
"y": {
"description": "A two dimensional array of y coordinates at each carpet point.",
"editType": "calc+clearAxisTypes",
"valType": "data_array",
"magic_underscores": "fig.update_traces(y=<VALUE>, selector=dict(type='carpet'))"
},
- "ysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `y`.",
- "editType": "none",
- "valType": "string"
- },
"a": {
"description": "An array containing values of the first parameter value",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(a=<VALUE>, selector=dict(type='carpet'))"
},
- "asrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `a`.",
- "editType": "none",
- "valType": "string"
- },
"a0": {
"description": "Alternate to `a`. Builds a linear space of a coordinates. Use with `da` where `a0` is the starting coordinate and `da` the step.",
"dflt": 0,
@@ -103659,11 +90846,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(b=<VALUE>, selector=dict(type='carpet'))"
},
- "bsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `b`.",
- "editType": "none",
- "valType": "string"
- },
"b0": {
"description": "Alternate to `b`. Builds a linear space of a coordinates. Use with `db` where `b0` is the starting coordinate and `db` the step.",
"dflt": 0,
@@ -103685,22 +90867,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='carpet'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='carpet'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "editType": "none",
- "valType": "string"
- },
"aaxis": {
"arraydtick": {
"description": "The stride between grid lines along the axis",
@@ -103747,11 +90919,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(aaxis_categoryarray=<VALUE>, selector=dict(type='carpet'))"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.",
"dflt": "trace",
@@ -104284,22 +91451,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(aaxis_ticktext=<VALUE>, selector=dict(type='carpet'))"
},
- "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",
"magic_underscores": "fig.update_traces(aaxis_tickvals=<VALUE>, selector=dict(type='carpet'))"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
"title": {
"editType": "calc",
"font": {
@@ -104479,11 +91636,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(baxis_categoryarray=<VALUE>, selector=dict(type='carpet'))"
},
- "categoryarraysrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `categoryarray`.",
- "editType": "none",
- "valType": "string"
- },
"categoryorder": {
"description": "Specifies the ordering logic for the case of categorical variables. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.",
"dflt": "trace",
@@ -105016,22 +92168,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(baxis_ticktext=<VALUE>, selector=dict(type='carpet'))"
},
- "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",
"magic_underscores": "fig.update_traces(baxis_tickvals=<VALUE>, selector=dict(type='carpet'))"
},
- "tickvalssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `tickvals`.",
- "editType": "none",
- "valType": "string"
- },
"title": {
"editType": "calc",
"font": {
@@ -105307,28 +92449,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='carpet'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='carpet'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='carpet'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='carpet'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='carpet'))"
},
"categories": [
@@ -105550,11 +92670,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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,
@@ -105568,35 +92683,20 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(a=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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",
"magic_underscores": "fig.update_traces(b=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "bsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `b`.",
- "editType": "none",
- "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.",
+ "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 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",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"textposition": {
"arrayOk": true,
"description": "Sets the positions of the `text` elements with respects to the (x,y) coordinates.",
@@ -105616,11 +92716,6 @@
],
"magic_underscores": "fig.update_traces(textposition=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "textpositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `textposition`.",
- "editType": "none",
- "valType": "string"
- },
"texttemplate": {
"arrayOk": true,
"description": "Template string used for rendering the information text that appears 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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All 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`.",
@@ -105636,27 +92731,17 @@
"valType": "any",
"magic_underscores": "fig.update_traces(texttemplatefallback=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "texttemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `texttemplate`.",
- "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.",
+ "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 data points in (a,b). To be seen, trace `hoverinfo` must contain a *text* flag.",
"dflt": "",
"editType": "style",
"valType": "string",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
+ "description": "Determines what trace information appears on hover. 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": [
@@ -105673,11 +92758,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverinfo=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "hoverinfosrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hoverinfo`.",
- "editType": "none",
- "valType": "string"
- },
"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. Variables that can't be found will be replaced with the specifier. For example, a template of \"data: %{x}, %{y}\" will result in a value of \"data: 1, %{y}\" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. 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, all 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 ``.",
@@ -105693,11 +92773,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(hovertemplatefallback=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "hovertemplatesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
- "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.",
@@ -105705,22 +92780,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
@@ -105755,11 +92820,6 @@
],
"magic_underscores": "fig.update_traces(marker_angleref=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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,
@@ -106287,22 +93347,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(marker_colorbar_ticktext=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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",
"magic_underscores": "fig.update_traces(marker_colorbar_tickvals=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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,
@@ -106414,7 +93464,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -106507,7 +93557,7 @@
"magic_underscores": "fig.update_traces(marker_colorbar=dict(...), selector=dict(type='scattercarpet'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -106517,11 +93567,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_colorscale=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"gradient": {
"color": {
@@ -106531,11 +93576,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(marker_gradient_color=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "calc",
"role": "object",
"type": {
@@ -106552,11 +93592,6 @@
],
"magic_underscores": "fig.update_traces(marker_gradient_type=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "typesrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `type`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_gradient=dict(...), selector=dict(type='scattercarpet'))"
},
"line": {
@@ -106628,7 +93663,7 @@
"magic_underscores": "fig.update_traces(marker_line_coloraxis=<VALUE>, selector=dict(type='scattercarpet'))"
},
"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.",
+ "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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. 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": {
@@ -106638,11 +93673,6 @@
"valType": "colorscale",
"magic_underscores": "fig.update_traces(marker_line_colorscale=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"dash": {
"arrayOk": true,
"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*).",
@@ -106659,11 +93689,6 @@
],
"magic_underscores": "fig.update_traces(marker_line_dash=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "dashsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `dash`.",
- "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.",
@@ -106681,11 +93706,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_line_width=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "widthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `width`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker_line=dict(...), selector=dict(type='scattercarpet'))"
},
"maxdisplayed": {
@@ -106705,11 +93725,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_opacity=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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,
@@ -106760,11 +93775,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_sizeref=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -106774,11 +93784,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(marker_standoff=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107275,11 +94280,6 @@
],
"magic_underscores": "fig.update_traces(marker_symbol=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "symbolsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `symbol`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(marker=dict(...), selector=dict(type='scattercarpet'))"
},
"line": {
@@ -107292,11 +94292,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(line_backoff=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "backoffsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `backoff`.",
- "editType": "none",
- "valType": "string"
- },
"color": {
"description": "Sets the line color.",
"editType": "style",
@@ -107357,11 +94352,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(textfont_color=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "colorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `color`.",
- "editType": "none",
- "valType": "string"
- },
"description": "Sets the text font.",
"editType": "calc",
"family": {
@@ -107373,11 +94363,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_family=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107394,11 +94379,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(textfont_lineposition=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -107408,11 +94388,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(textfont_shadow=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "calc",
@@ -107420,11 +94395,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(textfont_size=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107437,11 +94407,6 @@
],
"magic_underscores": "fig.update_traces(textfont_style=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107456,11 +94421,6 @@
],
"magic_underscores": "fig.update_traces(textfont_textcase=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107477,11 +94437,6 @@
],
"magic_underscores": "fig.update_traces(textfont_variant=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107496,11 +94451,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(textfont_weight=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(textfont=dict(...), selector=dict(type='scattercarpet'))"
},
"selectedpoints": {
@@ -107638,11 +94588,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_align=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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",
@@ -107650,11 +94595,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bgcolor=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107662,11 +94602,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_bordercolor=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "bordercolorsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `bordercolor`.",
- "editType": "none",
- "valType": "string"
- },
"editType": "none",
"font": {
"color": {
@@ -107675,11 +94610,6 @@
"valType": "color",
"magic_underscores": "fig.update_traces(hoverlabel_font_color=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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": {
@@ -107691,11 +94621,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_family=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107712,11 +94637,6 @@
"valType": "flaglist",
"magic_underscores": "fig.update_traces(hoverlabel_font_lineposition=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "linepositionsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `lineposition`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"shadow": {
"arrayOk": true,
@@ -107726,11 +94646,6 @@
"valType": "string",
"magic_underscores": "fig.update_traces(hoverlabel_font_shadow=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "shadowsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `shadow`.",
- "editType": "none",
- "valType": "string"
- },
"size": {
"arrayOk": true,
"editType": "none",
@@ -107738,11 +94653,6 @@
"valType": "number",
"magic_underscores": "fig.update_traces(hoverlabel_font_size=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107755,11 +94665,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_style=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107774,11 +94679,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_textcase=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107795,11 +94695,6 @@
],
"magic_underscores": "fig.update_traces(hoverlabel_font_variant=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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.",
@@ -107814,11 +94709,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_font_weight=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "weightsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `weight`.",
- "editType": "none",
- "valType": "string"
- },
"magic_underscores": "fig.update_traces(hoverlabel_font=dict(...), selector=dict(type='scattercarpet'))"
},
"namelength": {
@@ -107830,11 +94720,6 @@
"valType": "integer",
"magic_underscores": "fig.update_traces(hoverlabel_namelength=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "namelengthsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `namelength`.",
- "editType": "none",
- "valType": "string"
- },
"role": "object",
"showarrow": {
"description": "Sets whether or not to show the hover label arrow/triangle pointing to the data point.",
@@ -107861,28 +94746,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='scattercarpet'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='scattercarpet'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='scattercarpet'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='scattercarpet'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='scattercarpet'))"
},
"categories": [
@@ -108088,11 +94951,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(ids=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "idssrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `ids`.",
- "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,
@@ -108106,11 +94964,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(z=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "zsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `z`.",
- "editType": "none",
- "valType": "string"
- },
"a": {
"description": "Sets the x coordinates.",
"editType": "calc+clearAxisTypes",
@@ -108121,11 +94974,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(a=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "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",
@@ -108168,11 +95016,6 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(b=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "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",
@@ -108211,22 +95054,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(text=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "textsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `text`.",
- "editType": "none",
- "valType": "string"
- },
"hovertext": {
"description": "Same as `text`.",
"editType": "calc",
"valType": "data_array",
"magic_underscores": "fig.update_traces(hovertext=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "hovertextsrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `hovertext`.",
- "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.",
@@ -108234,22 +95067,12 @@
"valType": "any",
"magic_underscores": "fig.update_traces(meta=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "metasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `meta`.",
- "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",
"magic_underscores": "fig.update_traces(customdata=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "customdatasrc": {
- "description": "Sets the source reference on Chart Studio Cloud for `customdata`.",
- "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",
@@ -108774,22 +95597,12 @@
"valType": "data_array",
"magic_underscores": "fig.update_traces(colorbar_ticktext=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "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",
"magic_underscores": "fig.update_traces(colorbar_tickvals=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "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,
@@ -108901,7 +95714,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*.",
+ "description": "Determines the location of color bar's title with respect to the color bar. Defaults to *top* when `orientation` is *v* and defaults to *right* when `orientation` is *h*.",
"editType": "colorbars",
"valType": "enumerated",
"values": [
@@ -109004,7 +95817,7 @@
"magic_underscores": "fig.update_traces(autocolorscale=<VALUE>, selector=dict(type='contourcarpet'))"
},
"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, hsla, hwb, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are 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": {
@@ -109223,7 +96036,7 @@
"magic_underscores": "fig.update_traces(contours_labelformat=<VALUE>, selector=dict(type='contourcarpet'))"
},
"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.",
+ "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.",
"dflt": "=",
"editType": "calc",
"valType": "enumerated",
@@ -109329,28 +96142,6 @@
"valType": "any",
"magic_underscores": "fig.update_traces(uirevision=<VALUE>, selector=dict(type='contourcarpet'))"
},
- "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",
- "magic_underscores": "fig.update_traces(stream_maxpoints=<VALUE>, selector=dict(type='contourcarpet'))"
- },
- "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",
- "magic_underscores": "fig.update_traces(stream_token=<VALUE>, selector=dict(type='contourcarpet'))"
- },
- "magic_underscores": "fig.update_traces(stream=dict(...), selector=dict(type='contourcarpet'))"
- },
"magic_underscores": "fig.update_traces(..., selector=dict(type='contourcarpet'))"
},
"categories": [
diff --git a/_includes/layouts/head.html b/_includes/layouts/head.html
index c13b2da6a..a1f6c3673 100644
--- a/_includes/layouts/head.html
+++ b/_includes/layouts/head.html
@@ -35,7 +35,13 @@
{% endif %}
+ {% if page.language == "r" or page.language == "ggplot2" %}
+
+ {% else %}
+
+
+ {% endif %}
{% if page.language == "plotly_js" %}
diff --git a/_includes/layouts/reference-side-nav.html b/_includes/layouts/reference-side-nav.html
index 18018b187..efaf52640 100644
--- a/_includes/layouts/reference-side-nav.html
+++ b/_includes/layouts/reference-side-nav.html
@@ -1,3 +1,8 @@
+{% comment %}Python and JavaScript track the current plotly.js schema; the other
+languages' reference pages are frozen on older bundles, so they keep the legacy
+entries. See the note at the top of _data/make_ref_pages.py.{% endcomment %}
+{% assign v4ref = false %}
+{% if langue == "javascript" or langue == "python" %}{% assign v4ref = true %}{% endif %}
Simple Traces
@@ -295,7 +315,7 @@
Geo
}
};
- Plotly.newPlot(document.getElementById('wind-speed'), [trace], layout, {showLink: false});
+ Plotly.newPlot(document.getElementById('wind-speed'), [trace], layout);
});
diff --git a/_posts/plotly_js/2019-07-03-is-plotly-free-js.md b/_posts/plotly_js/2019-07-03-is-plotly-free-js.md
index 654c7aa2a..c6f97b378 100644
--- a/_posts/plotly_js/2019-07-03-is-plotly-free-js.md
+++ b/_posts/plotly_js/2019-07-03-is-plotly-free-js.md
@@ -16,13 +16,15 @@ language: plotly_js
#### Can I use Plotly.js without signing up to any service?
**Yes.** You can use Plotly.js to make, view, and distribute charts and maps without registering for any service,
-obtaining any token, or creating any account. The one exception is that to view tile maps
-which use tiles from the Mapbox service (which is optional, as [you can use other tile servers](/javascript/mapbox-layers)), you will need to have a Mapbox token.
+obtaining any token, or creating any account. The built-in tile map styles use open tile providers and need no token. Some
+third-party tile providers you can [point Plotly.js at](/javascript/tile-map-layers) do require an account with that
+provider — Stamen tiles, for instance, are served by Stadia Maps and need a Stadia API key. Sharing a chart with
+[Plotly Cloud](https://cloud.plotly.com) from the modebar requires a Plotly Cloud account, but nothing else does.
#### Can I use Plotly.js offline, without being connected to the internet?
**Yes.** You can use Plotly.js to make, view, and distribute graphics totally offline. The one exception is that to view tile maps
-which use tiles from a cloud-hosted service, such as Open Street Maps or Mapbox, you will need a connection to that service. You can view tile maps totally offline if you run your own local tile server and [use its tiles](/javascript/mapbox-layers).
+which use tiles from a cloud-hosted service, such as OpenStreetMap, you will need a connection to that service. You can view tile maps totally offline if you run your own local tile server and [use its tiles](/javascript/tile-map-layers).
#### Is Dash free?
diff --git a/_posts/plotly_js/3d/3d-isosurface/2019-04-16-basic-isosurface.html b/_posts/plotly_js/3d/3d-isosurface/2019-04-16-basic-isosurface.html
index 7e7e3da8b..620b3b24c 100644
--- a/_posts/plotly_js/3d/3d-isosurface/2019-04-16-basic-isosurface.html
+++ b/_posts/plotly_js/3d/3d-isosurface/2019-04-16-basic-isosurface.html
@@ -33,4 +33,4 @@
}
};
-Plotly.newPlot('myDiv', data, layout, {showSendToCloud: true});
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/3d/3d-isosurface/2019-04-16-isosurface-slices.html b/_posts/plotly_js/3d/3d-isosurface/2019-04-16-isosurface-slices.html
index 35cd65078..1fb5a4780 100644
--- a/_posts/plotly_js/3d/3d-isosurface/2019-04-16-isosurface-slices.html
+++ b/_posts/plotly_js/3d/3d-isosurface/2019-04-16-isosurface-slices.html
@@ -46,5 +46,5 @@
}
};
-Plotly.newPlot('myDiv', data, layout, {showSendToCloud: true});
+Plotly.newPlot('myDiv', data, layout);
});
diff --git a/_posts/plotly_js/3d/3d-isosurface/2019-04-16-multiple-isosurfaces-caps.html b/_posts/plotly_js/3d/3d-isosurface/2019-04-16-multiple-isosurfaces-caps.html
index cbe303429..2d59af0f4 100644
--- a/_posts/plotly_js/3d/3d-isosurface/2019-04-16-multiple-isosurfaces-caps.html
+++ b/_posts/plotly_js/3d/3d-isosurface/2019-04-16-multiple-isosurfaces-caps.html
@@ -43,6 +43,6 @@
}
};
-Plotly.newPlot('myDiv', data, layout, {showSendToCloud: true});
+Plotly.newPlot('myDiv', data, layout);
});
diff --git a/_posts/plotly_js/README.md b/_posts/plotly_js/README.md
index 82a5b5a00..18ba35509 100644
--- a/_posts/plotly_js/README.md
+++ b/_posts/plotly_js/README.md
@@ -122,7 +122,7 @@ Plotly.newPlot('myDiv', data);
- use "real" data to make the examples realistic and useful for users.
- avoid using random or dummy data as much as humanly possible! Should only be a last resort.
- upload data files to https://github.com/plotly/datasets as importing data rather than pasting a large chunk of data in the tutorial creates a cleaner example.
- - use `var config = {mapboxAccessToken: "your access token"};` if your chart requires Mapbox authentication. `"your access token` will replaced by Plotly's private token at build time. In development mode, you will need to create a `_data/mapboxtoken.yml` file and paste Plotly's non-URL restricted Mapbox key into it. This is available in 1Password.
+ - map examples must not require an API key. The `map` traces (`scattermap`, `choroplethmap`, `densitymap`) use open tile providers, and the `mapboxAccessToken` config option was removed in Plotly.js v4. Keep the example's `layout.map.style` set to a built-in style name or to a keyless style URL, so the chart renders for everyone reading the page. If you want to document a provider that does need a key, put that URL in `markdown_content` as a code snippet for the reader to copy and add their own key to — don't put it in the example itself, where a placeholder key means the rendered chart has no tiles and a real key would be committed to a public repo.
## Make a Pull Request
- Ready for your changes to be reviewed? Make a pull request!
diff --git a/_posts/plotly_js/animations/map-animations/2017-08-22-choropleth-animation.html b/_posts/plotly_js/animations/map-animations/2017-08-22-choropleth-animation.html
index 552dff20a..2bad23280 100644
--- a/_posts/plotly_js/animations/map-animations/2017-08-22-choropleth-animation.html
+++ b/_posts/plotly_js/animations/map-animations/2017-08-22-choropleth-animation.html
@@ -52,6 +52,7 @@
},
geo:{
scope: 'world',
+ fitbounds: false,
countrycolor: 'rgb(255, 255, 255)',
showland: true,
landcolor: 'rgb(217, 217, 217)',
diff --git a/_posts/plotly_js/basic/bubble/2015-04-09-bubblechart.html b/_posts/plotly_js/basic/bubble/2015-04-09-bubblechart.html
index 9cbb99505..ec70aa21b 100755
--- a/_posts/plotly_js/basic/bubble/2015-04-09-bubblechart.html
+++ b/_posts/plotly_js/basic/bubble/2015-04-09-bubblechart.html
@@ -12,7 +12,7 @@
y: [10, 11, 12, 13],
mode: 'markers',
marker: {
- color: ['hsl(0,100,40)', 'hsl(33,100,40)', 'hsl(66,100,40)', 'hsl(99,100,40)'],
+ color: ['hsl(0,100%,40%)', 'hsl(33,100%,40%)', 'hsl(66,100%,40%)', 'hsl(99,100%,40%)'],
size: [12, 22, 32, 42],
opacity: [0.6, 0.7, 0.8, 0.9]
},
diff --git a/_posts/plotly_js/basic/sankey/2017-05-22-add_nodes.html b/_posts/plotly_js/basic/sankey/2017-05-22-add_nodes.html
deleted file mode 100644
index 2f88e09df..000000000
--- a/_posts/plotly_js/basic/sankey/2017-05-22-add_nodes.html
+++ /dev/null
@@ -1,50 +0,0 @@
----
-name: Add Nodes
-language: plotly_js
-suite: sankey
-order: 3
-sitemap: false
-arrangement: horizontal
-description:
----
-
-d3.json('https://raw.githubusercontent.com/plotly/plotly.js/master/test/image/mocks/sankey_energy.json', function(fig){
-
-var data = {
- type: "sankey",
- domain: {
- x: [0,1],
- y: [0,1]
- },
- orientation: "h",
- valueformat: ".0f",
- valuesuffix: "TWh",
-
- node: {
- pad: 15,
- thickness: 15,
- line: {
- color: "black",
- width: 0.5
- },
- label: fig.data[0].node.label,
- color: fig.data[0].node.color
- }
-}
-
-var data = [data]
-
-var layout = {
- title: {
- text: "Energy forecast for 2050 Source: Department of Energy & Climate Change, Tom Counsell via Mike Bostock"
- },
- width: 1118,
- height: 772,
- font: {
- size: 10
- }
-}
-
-Plotly.newPlot('myDiv', data, layout)
-
-});
diff --git a/_posts/plotly_js/basic/sankey/2017-05-22-basic.html b/_posts/plotly_js/basic/sankey/2017-05-22-basic.html
deleted file mode 100644
index 25c79ff00..000000000
--- a/_posts/plotly_js/basic/sankey/2017-05-22-basic.html
+++ /dev/null
@@ -1,33 +0,0 @@
----
-name: Create Sankey Canvas
-language: plotly_js
-suite: sankey
-order: 2
-sitemap: false
-arrangement: horizontal
-description:
----
-
-var data = {
- type: "sankey",
- domain: {
- x: [0,1],
- y: [0,1]
- },
- orientation: "h",
- valueformat: ".0f",
- valuesuffix: "TWh"
-}
-
-var data = [data]
-
-var layout = {
- title: {
- text: "Energy forecast for 2050 Source: Department of Energy & Climate Change, Tom Counsell via Mike Bostock"
- },
- width: 1118,
- height: 772,
- font: {
- size: 10
- }
-}
diff --git a/_posts/plotly_js/basic/sankey/2017-05-22-add_links.html b/_posts/plotly_js/basic/sankey/2017-05-22-sankey-from-dataset.html
similarity index 74%
rename from _posts/plotly_js/basic/sankey/2017-05-22-add_links.html
rename to _posts/plotly_js/basic/sankey/2017-05-22-sankey-from-dataset.html
index e602514e1..e6b106d3f 100644
--- a/_posts/plotly_js/basic/sankey/2017-05-22-add_links.html
+++ b/_posts/plotly_js/basic/sankey/2017-05-22-sankey-from-dataset.html
@@ -1,16 +1,18 @@
---
-name: Add Links
+name: Sankey Diagram from a Dataset
language: plotly_js
suite: sankey
-order: 4
+order: 2
sitemap: false
arrangement: horizontal
-description:
+markdown_content: |
+ A sankey trace is defined by its `link` arrays — `source` and `target` hold indices into `node.label`, and `value`
+ sets the width of each flow. Node positions and heights are derived from the links attached to them.
---
d3.json('https://raw.githubusercontent.com/plotly/plotly.js/master/test/image/mocks/sankey_energy.json', function(fig){
-var data = {
+var trace = {
type: "sankey",
domain: {
x: [0,1],
@@ -38,13 +40,13 @@
}
}
-var data = [data]
+var data = [trace]
var layout = {
title: {
text: "Energy forecast for 2050 Source: Department of Energy & Climate Change, Tom Counsell via Mike Bostock"
},
- width: 1118,
+ width: 950,
height: 772,
font: {
size: 10
diff --git a/_posts/plotly_js/basic/sankey/2017-05-22-sankey_index.html b/_posts/plotly_js/basic/sankey/2017-05-22-sankey_index.html
index b39b8a322..a453e30d3 100755
--- a/_posts/plotly_js/basic/sankey/2017-05-22-sankey_index.html
+++ b/_posts/plotly_js/basic/sankey/2017-05-22-sankey_index.html
@@ -10,4 +10,4 @@
---
{% assign examples = site.posts | where:"language","plotly_js" | where:"suite","sankey" | sort: "order" %}
-{% include posts/auto_examples.html examples=examples %}
\ No newline at end of file
+{% include posts/auto_examples.html examples=examples %}
diff --git a/_posts/plotly_js/basic/sankey/2017-05-22-style_sankey.html b/_posts/plotly_js/basic/sankey/2017-05-22-style_sankey.html
index eaf7e3fd7..78a27b0e5 100644
--- a/_posts/plotly_js/basic/sankey/2017-05-22-style_sankey.html
+++ b/_posts/plotly_js/basic/sankey/2017-05-22-style_sankey.html
@@ -2,7 +2,7 @@
name: Style Sankey Diagram
language: plotly_js
suite: sankey
-order: 5
+order: 3
sitemap: false
arrangement: horizontal
description:
@@ -10,7 +10,7 @@
d3.json('https://raw.githubusercontent.com/plotly/plotly.js/master/test/image/mocks/sankey_energy_dark.json', function(fig){
-var data = {
+var trace = {
type: "sankey",
domain: {
x: [0,1],
@@ -37,13 +37,13 @@
}
}
-var data = [data]
+var data = [trace]
var layout = {
title: {
text: "Energy forecast for 2050 Source: Department of Energy & Climate Change, Tom Counsell via Mike Bostock"
},
- width: 1118,
+ width: 950,
height: 772,
font: {
size: 10,
diff --git a/_posts/plotly_js/basic/sankey/2018-03-13-basic-example.html b/_posts/plotly_js/basic/sankey/2018-03-13-basic-example.html
index 85bce2638..bc4523f9a 100644
--- a/_posts/plotly_js/basic/sankey/2018-03-13-basic-example.html
+++ b/_posts/plotly_js/basic/sankey/2018-03-13-basic-example.html
@@ -8,7 +8,7 @@
description:
---
-var data = {
+var trace = {
type: "sankey",
orientation: "h",
node: {
@@ -29,7 +29,7 @@
}
}
-var data = [data]
+var data = [trace]
var layout = {
title: {
@@ -40,4 +40,4 @@
}
}
-Plotly.react('myDiv', data, layout)
+Plotly.newPlot('myDiv', data, layout)
diff --git a/_posts/plotly_js/basic/sankey/2019-11-20-nodes-position.html b/_posts/plotly_js/basic/sankey/2019-11-20-nodes-position.html
index 15f4544f2..a273c079d 100644
--- a/_posts/plotly_js/basic/sankey/2019-11-20-nodes-position.html
+++ b/_posts/plotly_js/basic/sankey/2019-11-20-nodes-position.html
@@ -2,7 +2,7 @@
name: Define Node Position
language: plotly_js
suite: sankey
-order: 6
+order: 4
sitemap: false
arrangement: horizontal
description:
diff --git a/_posts/plotly_js/basic/sankey/2024-01-05-align-example.html b/_posts/plotly_js/basic/sankey/2024-01-05-align-example.html
index 2dd8c887e..7434c9351 100644
--- a/_posts/plotly_js/basic/sankey/2024-01-05-align-example.html
+++ b/_posts/plotly_js/basic/sankey/2024-01-05-align-example.html
@@ -2,14 +2,16 @@
name: Node Alignment
language: plotly_js
suite: sankey
-order: 7
+order: 5
sitemap: false
arrangement: horizontal
markdown_content : |
- You can set the alignment of nodes using `node.align`. In this example, we align nodes to the "right". `node.align` can also be set to "left", "center", or "justify". The default is "justify" if ``node.align` is not set, and is similar to aligning to the "left", except that nodes without outgoing links are moved to the right of the figure.
+ You can set the alignment of nodes using `node.align`. In this example, we align nodes to the "right". `node.align` can also be set to "left", "center", or "justify". The default is "justify" if `node.align` is not set, and is similar to aligning to the "left", except that nodes without outgoing links are moved to the right of the figure.
+
+ `node.align` only decides which column a node is placed in, for nodes whose position isn't already pinned by the links attached to them. It does not change which end of the diagram the sources sit on — for that, see [Flow Direction](#flow-direction).
---
-var data = {
+var trace = {
type: "sankey",
orientation: "h",
node: {
@@ -24,7 +26,7 @@
},
};
-var data = [data];
+var data = [trace];
var layout = {
title: {
diff --git a/_posts/plotly_js/basic/sankey/2026-08-04-sankey-direction.html b/_posts/plotly_js/basic/sankey/2026-08-04-sankey-direction.html
new file mode 100644
index 000000000..b9df08917
--- /dev/null
+++ b/_posts/plotly_js/basic/sankey/2026-08-04-sankey-direction.html
@@ -0,0 +1,38 @@
+---
+name: Flow Direction
+language: plotly_js
+suite: sankey
+order: 7
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ `direction` sets which way flows run along the `orientation` axis, so a diagram can be mirrored without reversing
+ your `link.source` and `link.target` data. The default, `'forward'`, puts sources first; `'reversed'` puts them last.
+ Combined with `orientation` (`'h'` or `'v'`) this gives four layouts: sources on the left, right, top, or bottom.
+ Node labels stay upright in every combination — only the flow geometry mirrors.
+
+ `direction` mirrors the finished layout: it does not reassign nodes to different columns. To change which column a node is placed in, use [Node Alignment](#node-alignment).
+---
+var data = [{
+ type: 'sankey',
+ orientation: 'h',
+ direction: 'reversed',
+ node: {
+ label: ['Coal', 'Gas', 'Solar', 'Grid', 'Residential', 'Industrial'],
+ pad: 15,
+ thickness: 20
+ },
+ link: {
+ source: [0, 1, 2, 3, 3],
+ target: [3, 3, 3, 4, 5],
+ value: [8, 4, 3, 9, 6]
+ }
+}];
+
+var layout = {
+ title: {text: "Reversed Flow (sources on the right)"},
+ width: 700,
+ height: 450
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/basic/sankey/2026-08-04-sankey-sort.html b/_posts/plotly_js/basic/sankey/2026-08-04-sankey-sort.html
new file mode 100644
index 000000000..57d9fb10a
--- /dev/null
+++ b/_posts/plotly_js/basic/sankey/2026-08-04-sankey-sort.html
@@ -0,0 +1,40 @@
+---
+name: Node and Link Ordering
+language: plotly_js
+suite: sankey
+order: 6
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ By default (`sort: 'auto'`) the layout reorders nodes within a column, and links within a node, to reduce crossings.
+ Set `node.sort` and `link.sort` to `'input'` to keep the order given in `node.label` and in
+ `link.source` / `link.target` instead. Use `'input'` when the order carries meaning, or when you need a
+ deterministic layout across renders — for animations or side-by-side comparisons.
+
+ This figure pairs sources `A, B, C, D` one-to-one with targets `Z, Y, X, W`, a maximally crossed input. With
+ `'auto'`, the source column is flipped so the flows run horizontally; with `'input'`, every crossing is preserved.
+ `sort` is not honored on diagrams whose links form a cycle, which use a different layout algorithm.
+---
+var data = [{
+ type: 'sankey',
+ node: {
+ label: ['A', 'B', 'C', 'D', 'Z', 'Y', 'X', 'W'],
+ pad: 15,
+ thickness: 20,
+ sort: 'input'
+ },
+ link: {
+ source: [0, 1, 2, 3],
+ target: [4, 5, 6, 7],
+ value: [4, 3, 2, 1],
+ sort: 'input'
+ }
+}];
+
+var layout = {
+ title: {text: "Input Order Preserved (sort: 'input')"},
+ width: 700,
+ height: 450
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/basic/sunburst/2019-04-11-large-number-of-slices.html b/_posts/plotly_js/basic/sunburst/2019-04-11-large-number-of-slices.html
index 4f547131c..4119bdf0f 100644
--- a/_posts/plotly_js/basic/sunburst/2019-04-11-large-number-of-slices.html
+++ b/_posts/plotly_js/basic/sunburst/2019-04-11-large-number-of-slices.html
@@ -31,5 +31,5 @@
};
-Plotly.newPlot('myDiv', data, layout, {showSendToCloud: true});
+Plotly.newPlot('myDiv', data, layout);
})
diff --git a/_posts/plotly_js/basic/sunburst/2019-06-13-basic-branchvalues-total.html b/_posts/plotly_js/basic/sunburst/2019-06-13-basic-branchvalues-total.html
index 79dd390f4..4089d57d0 100755
--- a/_posts/plotly_js/basic/sunburst/2019-06-13-basic-branchvalues-total.html
+++ b/_posts/plotly_js/basic/sunburst/2019-06-13-basic-branchvalues-total.html
@@ -29,6 +29,6 @@
};
-Plotly.newPlot('myDiv', data, layout, {showSendToCloud: true})
+Plotly.newPlot('myDiv', data, layout)
myPlot = document.getElementById("myDiv");
diff --git a/_posts/plotly_js/financial/funnel/2019-06-27-funnelarea.html b/_posts/plotly_js/financial/funnel/2019-06-27-funnelarea.html
index fd5d4c059..ff245bd4c 100755
--- a/_posts/plotly_js/financial/funnel/2019-06-27-funnelarea.html
+++ b/_posts/plotly_js/financial/funnel/2019-06-27-funnelarea.html
@@ -8,8 +8,8 @@
---
var gd = document.getElementById('myDiv');
var data = [{type: 'funnelarea', values: [5, 4, 3, 2, 1], text: ["The 1st", "The 2nd", "The 3rd", "The 4th", "The 5th"],
- marker: {colors: ["59D4E8", "DDB6C6", "A696C8", "67EACA", "94D2E6"],
- line: {color: ["3E4E88", "606470", "3E4E88", "606470", "3E4E88"], width: [2, 1, 5, 0, 3]}},
+ marker: {colors: ["#59D4E8", "#DDB6C6", "#A696C8", "#67EACA", "#94D2E6"],
+ line: {color: ["#3E4E88", "#606470", "#3E4E88", "#606470", "#3E4E88"], width: [2, 1, 5, 0, 3]}},
textfont: {family: "Old Standard TT", size: 13, color: "black"}, opacity: 0.65}];
var layout = {margin: {l: 200 , r: 200}, funnelmode: "stack", showlegend: 'True'}
diff --git a/_posts/plotly_js/financial/funnel/2019-06-27-part-of-whole-funnel.html b/_posts/plotly_js/financial/funnel/2019-06-27-part-of-whole-funnel.html
index eab16fd2c..6a3769339 100755
--- a/_posts/plotly_js/financial/funnel/2019-06-27-part-of-whole-funnel.html
+++ b/_posts/plotly_js/financial/funnel/2019-06-27-part-of-whole-funnel.html
@@ -11,8 +11,8 @@
var data = [{type: 'funnel',
y: ["Sales person A", "Sales person B", "Sales person C", "Sales person D", "Sales person E"],
x: [1200, 909.4, 600.6, 300, 80], textposition: "inside", textinfo: "value+percent initial",
- hoverinfo: 'percent total+x', opacity: 0.65, marker: {color: ["59D4E8", "DDB6C6", "A696C8", "67EACA", "94D2E6"],
- line: {"width": [4, 2, 2, 3, 1, 1], color: ["3E4E88", "606470", "3E4E88", "606470", "3E4E88"]}},
+ hoverinfo: 'percent total+x', opacity: 0.65, marker: {color: ["#59D4E8", "#DDB6C6", "#A696C8", "#67EACA", "#94D2E6"],
+ line: {"width": [4, 2, 2, 3, 1, 1], color: ["#3E4E88", "#606470", "#3E4E88", "#606470", "#3E4E88"]}},
connector: {line: {color: "royalblue", dash: "dot", width: 3}}}];
var layout = {margin: {l: 100}, width: 600, height: 500}
diff --git a/_posts/plotly_js/fundamentals/colors/2026-08-04-color-formats.html b/_posts/plotly_js/fundamentals/colors/2026-08-04-color-formats.html
new file mode 100644
index 000000000..b29101de9
--- /dev/null
+++ b/_posts/plotly_js/fundamentals/colors/2026-08-04-color-formats.html
@@ -0,0 +1,36 @@
+---
+name: Color Format Examples
+language: plotly_js
+suite: colors
+order: 1
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ One bar per accepted color format, each written a different way but all resolving to a valid color.
+---
+var data = [{
+ type: 'bar',
+ x: ['named', 'hex', 'hex + alpha', 'rgb', 'rgb / alpha', 'hsl', 'hwb'],
+ y: [1, 1, 1, 1, 1, 1, 1],
+ marker: {
+ color: [
+ 'crimson',
+ '#2ca02c',
+ '#1f77b4aa',
+ 'rgb(255 127 14)',
+ 'rgba(148, 103, 189, 0.45)',
+ 'hsl(180, 70%, 40%)',
+ 'hwb(320 10% 20%)'
+ ],
+ line: {color: '#444', width: 1}
+ }
+}];
+
+var layout = {
+ title: {text: 'Accepted Color String Formats'},
+ yaxis: {visible: false},
+ width: 700,
+ height: 400
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/fundamentals/colors/2026-08-04-colors_plotly_js_index.html b/_posts/plotly_js/fundamentals/colors/2026-08-04-colors_plotly_js_index.html
new file mode 100644
index 000000000..9d3767ad2
--- /dev/null
+++ b/_posts/plotly_js/fundamentals/colors/2026-08-04-colors_plotly_js_index.html
@@ -0,0 +1,66 @@
+---
+description: How to specify colors in JavaScript. The CSS color string formats Plotly.js accepts for every color attribute.
+display_as: file_settings
+language: plotly_js
+layout: base
+name: Specifying Colors
+order: 27
+page_type: example_index
+permalink: javascript/colors/
+thumbnail: thumbnail/colorway.jpg
+---
+
+
Every color attribute in Plotly.js — marker.color, line.color,
+fillcolor, paper_bgcolor, and the rest — accepts a CSS color string. Plotly.js v4 parses
+colors according to the CSS Color 4 specification.
+
+
Accepted formats
+
+
+
Format
Notes
Examples
+
+
Named colors
+
Any CSS color keyword
+
'red', 'cornflowerblue', 'transparent'
+
+
+
Hex
+
3-, 4-, 6-, or 8-digit, always with a leading #
+
'#f00', '#f00a', '#ff0000', '#ff0000aa'
+
+
+
rgb(), rgba()
+
Comma- or space-separated, with optional slash alpha
Percent units required on saturation and lightness
+
'hsl(0, 100%, 50%)', 'hsl(0 100% 50% / 0.5)'
+
+
+
hwb()
+
Hue-whiteness-blackness, space-separated
+
'hwb(0 0% 0%)'
+
+
+
Hue
+
Given in degrees, with or without the deg unit
+
'hsl(0deg 100% 50%)', 'hsl(0 100% 50%)'
+
+
+
+
These are all parsed in JavaScript and normalized to rgb() / rgba() before being written
+to the DOM in the browser.
+
+
A color string that Plotly.js cannot parse falls back to the attribute's default, so the figure renders in the wrong
+color rather than failing loudly. If you are upgrading from an earlier version, see
+Migrating to Plotly.js v4 for the formats that are no longer
+accepted.
+
+
These rules apply to color strings only. Numeric arrays used for color mapping, such as
+marker.color: [1, 2, 3, 4] paired with a colorscale, are
+unaffected.
+
+{% assign examples = site.posts | where:"language","plotly_js" | where:"suite","colors" | sort: "order" %}
+{% include posts/auto_examples.html examples=examples %}
diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-link-text.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-link-text.html
deleted file mode 100644
index e3f409e76..000000000
--- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-link-text.html
+++ /dev/null
@@ -1,27 +0,0 @@
----
-name: Customize The `Edit Chart` Link Text
-language: plotly_js
-suite: configuration
-order: 7
-sitemap: false
-arrangement: horizontal
----
-var data = [{
- z: [[0, 1, 2, 3, 4, 5, 6],
- [1, 9, 4, 7, 5, 2, 4],
- [2, 4, 2, 1, 6, 9, 3]],
- type: 'heatmap'}]
-
-var layout = {
- title: {
- text: 'Customize The Edit Chart Link Text'
- }
-};
-
-var config = {
- showLink: true,
- plotlyServerURL: "https://chart-studio.plotly.com",
- linkText: 'This text is custom!'
-};
-
-Plotly.newPlot('myDiv', data, layout, config)
diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-showlink.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-showlink.html
deleted file mode 100644
index b75ab5859..000000000
--- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-opt-showlink.html
+++ /dev/null
@@ -1,32 +0,0 @@
----
-name: Display the `Edit Chart` Link
-language: plotly_js
-suite: configuration
-order: 6
-sitemap: false
-arrangement: horizontal
-markdown_content: |
- Note: showLink now defaults to false.
----
-
-var trace1 = {
- x: [0, 1, 2, 3, 4, 5, 6],
- y: [1, 9, 4, 7, 5, 2, 4],
- mode: 'lines+markers',
- type: 'scatter'
-};
-
-var data = [trace1];
-
-var layout = {
- title: {
- text: 'Display the Edit Chart Link'
- }
-};
-
-var config = {
- showLink: true,
- plotlyServerURL: "https://chart-studio.plotly.com"
-};
-
-Plotly.newPlot('myDiv', data, layout, config);
diff --git a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-showSendToCloud.html b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-showSendToCloud.html
index 0a906c626..9b7df5f52 100644
--- a/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-showSendToCloud.html
+++ b/_posts/plotly_js/fundamentals/config-options/2015-09-24-config-showSendToCloud.html
@@ -1,10 +1,18 @@
---
-name: Display Edit in Chart Studio Modebar Button
+name: Share a Chart to Plotly Cloud
language: plotly_js
suite: configuration
-order: 7.1
+order: 6
sitemap: false
arrangement: horizontal
+markdown_content: |
+ The `sendChartToCloud` modebar button, labelled "Share chart…", sends the chart to
+ [Plotly Cloud](https://cloud.plotly.com) and opens it in a new tab, where you can copy a sharing link and set the
+ chart's visibility. Clicking it first brings up a confirmation dialog naming the destination. A Plotly Cloud account
+ is required.
+
+ The button is shown by default. Set `showSendToCloud: false` to hide it, or set `plotlyServerURL` to send charts to
+ a self-hosted or alternate server instead of the default `https://cloud.plotly.com/newchart`.
---
var data = [{
values: [19, 26, 55],
@@ -14,13 +22,13 @@
var layout = {
title: {
- text: 'Show Edit in Chart Studio Modebar Button'
+ text: 'Share a Chart to Plotly Cloud'
}
};
var config = {
- showEditInChartStudio: true,
- plotlyServerURL: "https://chart-studio.plotly.com"
+ showSendToCloud: true,
+ plotlyServerURL: "https://cloud.plotly.com/newchart"
};
Plotly.newPlot('myDiv', data, layout, config);
diff --git a/_posts/plotly_js/fundamentals/config-options/2019-10-24-double-click-delay.html b/_posts/plotly_js/fundamentals/config-options/2019-10-24-double-click-delay.html
index 29c457dae..ac3aae795 100755
--- a/_posts/plotly_js/fundamentals/config-options/2019-10-24-double-click-delay.html
+++ b/_posts/plotly_js/fundamentals/config-options/2019-10-24-double-click-delay.html
@@ -7,7 +7,7 @@
arrangement: horizontal
markdown_content: |
Sets the maximum delay between two consecutive clicks to be interpreted as a double-click in ms. This is the time interval between first mousedown, and' second mouseup. The default timing is 300 ms (less than half a second).
- This setting propagates to all on-subplot double clicks, (except for geo, map, and mapbox).
+ This setting propagates to all on-subplot double clicks, (except for geo and map).
---
var data = [{
type: "bar",
diff --git a/_posts/plotly_js/fundamentals/config-options/2020-01-24-remove-modebarButtons.html b/_posts/plotly_js/fundamentals/config-options/2020-01-24-remove-modebarButtons.html
index 75190eedb..f9704eae5 100644
--- a/_posts/plotly_js/fundamentals/config-options/2020-01-24-remove-modebarButtons.html
+++ b/_posts/plotly_js/fundamentals/config-options/2020-01-24-remove-modebarButtons.html
@@ -12,7 +12,8 @@
---
var data = [{
diff --git a/_posts/plotly_js/fundamentals/latex/2015-04-09-latex.html b/_posts/plotly_js/fundamentals/latex/2015-04-09-latex.html
index 569c1754e..fc41e35cf 100644
--- a/_posts/plotly_js/fundamentals/latex/2015-04-09-latex.html
+++ b/_posts/plotly_js/fundamentals/latex/2015-04-09-latex.html
@@ -6,7 +6,7 @@
order: 0
sitemap: false
---
-// remember to load MathJax.js?config=TeX-MML-AM_CHTML
+// remember to load MathJax v3 or v4 (tex-svg.js) - see https://plotly.com/javascript/LaTeX/
var trace1 = {
x: [1, 2, 3, 4],
y: [1, 4, 9, 16],
diff --git a/_posts/plotly_js/fundamentals/latex/2015-04-09-latex_plotly_js_index.html b/_posts/plotly_js/fundamentals/latex/2015-04-09-latex_plotly_js_index.html
index d4f33c035..034837272 100755
--- a/_posts/plotly_js/fundamentals/latex/2015-04-09-latex_plotly_js_index.html
+++ b/_posts/plotly_js/fundamentals/latex/2015-04-09-latex_plotly_js_index.html
@@ -11,5 +11,22 @@
thumbnail: thumbnail/venn.jpg
---
+
Plotly.js renders LaTeX in titles, axis labels, annotations, and legend entries when
+MathJax is loaded on the page. Wrap the expression in
+$ delimiters, as in the example below.
+
+
Plotly.js v4 supports MathJax v3 and v4, and uses the tex-svg component. Load one of the following
+before plotly.js:
MathJax v2 is no longer supported. If your page loads
+MathJax.js?config=TeX-MML-AM_CHTML, replace it with one of the tags above — the
+?config= query string is not used from MathJax v3 onward, since the component is
+selected by the file you load.
+
{% assign examples = site.posts | where:"language","plotly_js" | where:"suite","latex" | sort: "order" %}
{% include posts/auto_examples.html examples=examples %}
\ No newline at end of file
diff --git a/_posts/plotly_js/fundamentals/static-image-export/2016-05-20-static-image.md b/_posts/plotly_js/fundamentals/static-image-export/2016-05-20-static-image.md
index cf77e1f0d..2b61807a7 100644
--- a/_posts/plotly_js/fundamentals/static-image-export/2016-05-20-static-image.md
+++ b/_posts/plotly_js/fundamentals/static-image-export/2016-05-20-static-image.md
@@ -60,7 +60,7 @@ You can also save the image using different formats.
The common image formats: 'PNG', 'JPG/JPEG' are supported. In addition, formats like 'EPS', 'SVG' and 'PDF' are also available for user with a Personal or Professional subscription. You can get more details on our [pricing page] (https://plotly.com/products/cloud/)
-**Note:** It is important to note that any figures containing WebGL traces (i.e. of type scattergl, heatmapgl, contourgl, scatter3d, surface, mesh3d, scatterpolargl, cone, streamtube, splom, or parcoords) that are exported in a vector format like SVG, EPS or PDF will include encapsulated rasters instead of vectors for some parts of the image.
+**Note:** It is important to note that any figures containing WebGL traces (i.e. of type scattergl, scatter3d, surface, mesh3d, scatterpolargl, cone, streamtube, splom, or parcoords) that are exported in a vector format like SVG, EPS or PDF will include encapsulated rasters instead of vectors for some parts of the image.
## Saving as PNG ##
img_png.attr("src", url);
diff --git a/_posts/plotly_js/fundamentals/tick-format/2018-12-17-how-to-tick-format-layout.html b/_posts/plotly_js/fundamentals/tick-format/2018-12-17-how-to-tick-format-layout.html
index 4c4254926..bb06f3779 100644
--- a/_posts/plotly_js/fundamentals/tick-format/2018-12-17-how-to-tick-format-layout.html
+++ b/_posts/plotly_js/fundamentals/tick-format/2018-12-17-how-to-tick-format-layout.html
@@ -27,10 +27,6 @@
tickvals: [ /* */ ],
/* Set the text displayed at the ticks position via tickvals */
ticktext: [ /* */ ],
- /* Set the source reference for tickvals */
- tickvalssrc: '',
- /* Set the source reference for ticktext */
- tickvtextsrc: '',
/* Set the tick label formatting rule using d3 formatting mini-languages */
tickformat: '',
diff --git a/_posts/plotly_js/guides/2026-07-17-plotly_js-guides-index.html b/_posts/plotly_js/guides/2026-07-17-plotly_js-guides-index.html
new file mode 100644
index 000000000..85859b6a6
--- /dev/null
+++ b/_posts/plotly_js/guides/2026-07-17-plotly_js-guides-index.html
@@ -0,0 +1,25 @@
+---
+permalink: javascript/guides/
+description: Guides for Plotly.js, including migration guides between major versions with breaking changes and before/after examples.
+name: Guides
+layout: langindex
+display_as: guide
+language: plotly_js
+thumbnail: thumbnail/mixed.jpg
+---
+
+
+
+
+
+
+
Plotly.js Guides
+
{{page.description}}
+ {% include layouts/dashplug.html %}
+
+
+
+
+
+ {% assign languagelist = site.posts | where:"language","plotly_js" | where:"display_as","guide" | where: "layout","base" | sort: "order" %}
+ {% include posts/documentation_eg.html %}
diff --git a/_posts/plotly_js/fundamentals/plotly-js-3-changes/2024-10-09-plotly-js-3-changes.md b/_posts/plotly_js/guides/migrating-to-v3/2024-10-09-migrating-to-v3.md
similarity index 97%
rename from _posts/plotly_js/fundamentals/plotly-js-3-changes/2024-10-09-plotly-js-3-changes.md
rename to _posts/plotly_js/guides/migrating-to-v3/2024-10-09-migrating-to-v3.md
index dabc03d0c..b706b023e 100644
--- a/_posts/plotly_js/fundamentals/plotly-js-3-changes/2024-10-09-plotly-js-3-changes.md
+++ b/_posts/plotly_js/guides/migrating-to-v3/2024-10-09-migrating-to-v3.md
@@ -1,13 +1,16 @@
---
description: Learn about the changes in Plotly.js version 3.
-display_as: file_settings
+display_as: guide
language: plotly_js
layout: base
-name: Version 3 Changes
-order: 27
+name: Migrating to Plotly.js v3
+order: 3
page_type: u-guide
-permalink: javascript/version-3-changes/
-redirect_from: javascript/pointcloud/
+permalink: javascript/guides/migrating-to-v3/
+redirect_from:
+- javascript/pointcloud/
+- javascript/version-3-changes/
+- javascript/migrating-to-v3/
sitemap: false
thumbnail: thumbnail/pointcloud.jpg
---
@@ -359,4 +362,4 @@ var data = [{
cmin: 0,
cmax: 100
}];
-```
\ No newline at end of file
+```
diff --git a/_posts/plotly_js/guides/migrating-to-v4/2026-07-17-migrating-to-v4.md b/_posts/plotly_js/guides/migrating-to-v4/2026-07-17-migrating-to-v4.md
new file mode 100644
index 000000000..b11cd824f
--- /dev/null
+++ b/_posts/plotly_js/guides/migrating-to-v4/2026-07-17-migrating-to-v4.md
@@ -0,0 +1,239 @@
+---
+description: Quick checklist of code changes to update existing Plotly.js v3 charts for v4.
+display_as: guide
+language: plotly_js
+layout: base
+name: Migrating to Plotly.js v4
+order: 2
+page_type: u-guide
+permalink: javascript/guides/migrating-to-v4/
+redirect_from:
+- javascript/migrating-to-v4/
+sitemap: false
+thumbnail: thumbnail/mixed.jpg
+---
+# Migrating to Plotly.js v4
+
+This is a quick checklist of code changes needed to update existing Plotly.js
+v3 charts for v4. For full detail on every new feature and breaking change,
+see [What's New in Plotly.js
+v4](/javascript/guides/whats-new-in-v4/).
+
+Most figures will render without changes. The items below call out where
+existing code or input needs to be updated.
+
+## Contents
+
+- [Minimum Node.js version](#minimum-nodejs-version)
+- [Removed color inputs](#removed-color-inputs)
+- [Removed Chart Studio APIs](#removed-chart-studio-apis)
+- [Removed mapbox traces and subplots](#removed-mapbox-traces-and-subplots)
+- [Country name lookup](#country-name-lookup)
+- [Auto-fitting on `map` and `geo` subplots](#auto-fitting-on-map-and-geo-subplots)
+- [Scattermap rendering changes](#scattermap-rendering-changes)
+- [Shape legend `line.dash`](#shape-legend-line-dash)
+- [Overlaying axis `tickmode`](#overlaying-axis-tickmode)
+- [`splom.axis.matches` default](#splomaxismatches-default)
+- [Sankey layout](#sankey-layout)
+- [MathJax v2 dropped](#mathjax-v2-dropped)
+
+---
+
+## Minimum Node.js version
+
+Plotly.js now requires Node.js v22 or newer. Upgrade if you build from source,
+run Plotly in a Node runtime (SSR via jsdom, image export pipelines,
+validation scripts), or use `yarn` / `pnpm` (which enforce `engines`
+strictly).
+
+Consumers of the pre-built browser bundle are unaffected.
+
+---
+
+## Removed color inputs
+
+Plotly.js colors now conform thoroughly to the [CSS standard](https://www.w3.org/TR/css-color-4/). As a result
+the following color-input formats no longer behave as before. `hsv()` and bare-hex
+inputs are now invalid and fall back to the attribute's default; fractional
+`rgb()` is no longer rescaled and now renders near-black instead of the
+intended color:
+
+| Input | What to do |
+|---|---|
+| `hsv()` / `hsva()` strings | Convert to `hsl()`, `hwb()`, hex, or `rgb()` |
+| `hsl()` / `hsla()` strings without percent units on saturation and lightness (e.g. `'hsl(0, 100, 40)'`, `'hsl(0 100 40)'`) | Add the units (e.g. `'hsl(0, 100%, 40%)'`) |
+| `rgb()` / `rgba()` strings with 0–1 decimal fractions | Convert `'rgb(0.5, 0.5, 0.5)'` to `'rgb(128, 128, 128)'` (or any supported string form) |
+| Hex strings without a leading `#` (e.g. `'fff'`, `'F00'`) | Add the `#` (e.g. `'#fff'`, `'#F00'`) |
+
+Note that these formats only affect *string* colors. Numeric color arrays
+used for color mapping (e.g. `marker.color: [1, 2, 3, 4]` paired with a
+`colorscale`) are unchanged and remain valid. For the full list of formats
+Plotly.js accepts, see [Specifying Colors](/javascript/colors/).
+
+Auto-computed contrast colors (heatmap text, `insidetextfont` on
+bars/waterfall, sankey hover on dark BG) may also shift by a few RGB units
+around mid-luminance backgrounds.
+
+---
+
+## Removed Chart Studio APIs
+
+Config options removed from `Plotly.newPlot(gd, data, layout, config)`:
+
+| Removed | Replacement |
+|---|---|
+| `showLink`, `linkText`, `sendData`, `showSources` | None — remove them |
+| `showEditInChartStudio` | `showSendToCloud` |
+
+The `editInChartStudio` modebar button is gone — switch to `showSendToCloud`.
+
+```js
+// Before
+Plotly.newPlot(gd, data, layout, {
+ showLink: true,
+ linkText: 'View on Plotly',
+ showEditInChartStudio: true,
+});
+
+// After
+Plotly.newPlot(gd, data, layout, {
+ showSendToCloud: true,
+});
+```
+
+The **"Share chart…" button (`sendChartToCloud`) is now on by
+default**. If you don't want the button visible, it can be turned off as follows:
+
+```js
+Plotly.newPlot(gd, data, layout, { showSendToCloud: false });
+```
+
+---
+
+## Removed mapbox traces and subplots
+
+The legacy Mapbox-based traces and subplot type are gone. Rename to the
+MapLibre-based `map` family. For more information, see [Mapbox
+to MapLibre migration](https://plotly.com/python/mapbox-to-maplibre/).
+
+| Removed | Replacement |
+|---|---|
+| `scattermapbox` | `scattermap` |
+| `choroplethmapbox` | `choroplethmap` |
+| `densitymapbox` | `densitymap` |
+| `layout.mapbox` (and `mapbox2`, `mapbox3`, …) | `layout.map` (and `map2`, `map3`, …) |
+| `layout.mapbox.accesstoken`, `config.mapboxAccessToken` | None — MapLibre uses open tile providers |
+| `plotly-mapbox.min.js` partial bundle | `plotly-map.min.js` |
+| Modebar buttons `zoomInMapbox`, `zoomOutMapbox`, `resetViewMapbox` | `zoomInMap`, `zoomOutMap`, `resetViewMap` |
+| `scrollZoom: 'mapbox'` (e.g. `'mapbox+cartesian'`) | `'map'` |
+
+The attribute shape is unchanged — usually a straight rename works:
+
+```js
+// Before
+{
+ data: [{ type: 'scattermapbox', lon: [...], lat: [...] }],
+ layout: { mapbox: { style: 'open-street-map', center: {...}, zoom: 2 } },
+ config: { mapboxAccessToken: 'pk.eyJ1...' },
+}
+
+// After
+{
+ data: [{ type: 'scattermap', lon: [...], lat: [...] }],
+ layout: { map: { style: 'open-street-map', center: {...}, zoom: 2 } },
+ // mapboxAccessToken removed
+}
+```
+
+Built-in style names still work but use different tile providers (Carto,
+ArcGIS, OpenStreetMap), so the visual appearance will change. Stamen styles
+(`stamen-terrain`, `-toner`, `-watercolor`) are no longer built in — they now
+require a Stadia API key. The `mapbox://styles/mapbox/...` short-form URL is
+no longer supported.
+
+---
+
+## Country name lookup
+
+`locationmode: 'country names'` (on `choropleth` and `scattergeo` traces) now
+uses a different library for looking up names. The vast majority of country
+names are handled exactly the same with the new library; a small number of
+legacy entries have been removed. If a name isn't matching in a plot, switch
+to a [canonical country name, an alias, or an ISO-3 / ISO-2 code](https://github.com/plotly/country-iso-search/blob/878c3a8a140aade85e109088d3e8edbc34fcda9d/src/countries.ts).
+
+---
+
+## Auto-fitting on `map` and `geo` subplots
+
+Both subplot types now auto-fit their initial view to trace data.
+
+**For `map` subplots** (`scattermap`, `densitymap`): set `map.fitbounds:
+false`, or set `map.center` / `map.zoom` explicitly, to disable auto-fit.
+
+**For `geo` subplots** (`scattergeo`, `choropleth`): `layout.geo.fitbounds`
+now defaults to `'locations'` (previously `false`). Set `fitbounds: false`, or
+set any view attribute (`center`, `projection.rotation`, `projection.scale`,
+`lonaxis.range`, `lataxis.range`), to disable auto-fit.
+
+Figures that already supply view attributes render unchanged.
+
+```js
+// Restore v3 world view for a map subplot
+{ map: { fitbounds: false } }
+
+// Restore v3 world view for a geo subplot
+{ geo: { fitbounds: false } }
+```
+
+---
+
+## Scattermap rendering changes
+
+| Change | Detail |
+|---|---|
+| Marker icons now respect `marker.color` | To maintain the v3 behavior, pass `marker.color: 'black'` |
+| Maki icons updated from v2.1 to 8.2 | A handful of icon names were removed between v2.1 and v8.2. See the [list](https://labs.mapbox.com/maki-icons/) of available icons. |
+| Legend swatches always draw a circle | Regardless of `marker.symbol`. In v3, symbols whose names overlap the Plotly set (`'square'`, `'star'`, …) drew broken or empty swatch paths; those now render as circles, consistent with every other scattermap trace. |
+
+---
+
+## Overlaying axis `tickmode`
+
+An axis that overlays another axis (`layout.xaxis2.overlaying: 'x'`,
+`layout.yaxis2.overlaying: 'y'`, etc.) now defaults its `tickmode` to `'sync'`
+— the overlay draws its ticks at the base axis's positions with its own
+range's labels. Set `tickmode: 'auto'` on the overlay to restore v3's
+independent-grid behavior:
+
+```js
+{ yaxis2: { overlaying: 'y', side: 'right', tickmode: 'auto' } }
+```
+
+---
+
+## `splom.axis.matches` default
+
+`splom` (scatter plot matrix) traces now default `axis.matches` to `true`, so
+axes on the same row/column are linked and pan/zoom together. In v3 the
+default was `false` (each cell independent). To restore v3 behavior on a
+specific splom, set `matches: false` on its axes explicitly.
+
+---
+
+## Sankey layout
+
+`@plotly/d3-sankey` was upgraded from 0.7.2 to 0.12.3. Node y-positions and link paths may change slightly.
+
+---
+
+## MathJax v2 support removed
+
+Plotly.js now supports **MathJax v3 and v4** for LaTeX rendering. **MathJax
+v2 support has been removed**. If your page bundles MathJax v2, upgrade to v3 or v4:
+
+```html
+
+
+
+
+```
diff --git a/_posts/plotly_js/guides/typescript/2026-08-04-typescript.md b/_posts/plotly_js/guides/typescript/2026-08-04-typescript.md
new file mode 100644
index 000000000..57db0a4b1
--- /dev/null
+++ b/_posts/plotly_js/guides/typescript/2026-08-04-typescript.md
@@ -0,0 +1,121 @@
+---
+description: How to use Plotly.js with TypeScript, including the types it ships and how to type figures, layouts, configs, and events.
+display_as: guide
+language: plotly_js
+layout: base
+name: Using Plotly.js with TypeScript
+order: 4
+page_type: u-guide
+permalink: javascript/guides/typescript/
+sitemap: false
+thumbnail: thumbnail/theming-and-templates.png
+---
+# Using Plotly.js with TypeScript
+
+Since v4, Plotly.js ships its own TypeScript type definitions. `package.json` points
+`"types"` at `lib/index.d.ts`, so they are picked up automatically — there is no
+separate `@types/*` package to install.
+
+## Importing
+
+The package provides a default namespace, named exports, and a global `Plotly`
+namespace, so all of these work:
+
+```ts
+import Plotly from 'plotly.js';
+// or
+import * as Plotly from 'plotly.js';
+// or
+import { newPlot } from 'plotly.js';
+import type { Layout, Data, TraceType } from 'plotly.js';
+```
+
+A minimal typed figure:
+
+```ts
+import { newPlot } from 'plotly.js';
+import type { Data, Layout } from 'plotly.js';
+
+const data: Data[] = [{ type: 'scatter', x: [1, 2, 3], y: [4, 5, 6] }];
+const layout: Partial = { title: { text: 'Demo' } };
+
+await newPlot(div, data, layout);
+```
+
+## Typing trace data
+
+`Data` is the union of every trace's data object, and it discriminates on `type`.
+Annotating a figure as `Data[]` therefore gets each entry checked against the right
+trace shape:
+
+```ts
+const data: Data[] = [
+ { type: 'bar', x: ['a', 'b'], y: [1, 2] }, // checked as BarData
+ { type: 'scatter', x: [1, 2], mode: 'lines' }, // checked as ScatterData
+];
+```
+
+Per-trace interfaces (`ScatterData`, `BarData`, `HeatmapData`, `ChoroplethData`, …)
+are exported too. Reach for them when a value is guaranteed to be one trace type —
+for example a helper that builds a `BarData` to push into a `Data[]` — and prefer the
+`Data` union everywhere else.
+
+## Typing layout and config
+
+`Layout` describes the layout object you pass in, so use `Partial`: nearly
+every field is optional, and the full interface would require all of them.
+`Config` types the config argument.
+
+```ts
+import type { Config, Layout } from 'plotly.js';
+
+const layout: Partial = {
+ title: { text: 'Quarterly revenue' },
+ yaxis: { tickformat: '$,.0f' },
+};
+
+const config: Partial = { responsive: true, showSendToCloud: false };
+```
+
+Note that `Layout` and `Data` are *input* shapes. The post-coerce internal shapes
+that Plotly computes from them (often called "FullLayout" and "FullData") are
+deliberately not exported.
+
+## Typing events
+
+Event payloads have their own interfaces, and `PlotlyHTMLElement` types the graph
+div that `newPlot` resolves to:
+
+```ts
+import { newPlot } from 'plotly.js';
+import type { PlotMouseEvent, PlotRelayoutEvent } from 'plotly.js';
+
+const gd = await newPlot(div, data, layout);
+
+gd.on('plotly_click', (event: PlotMouseEvent) => {
+ console.log(event.points[0].x, event.points[0].y);
+});
+
+gd.on('plotly_relayout', (event: PlotRelayoutEvent) => {
+ console.log(event['xaxis.range[0]']);
+});
+```
+
+`PlotlyEventName` is the union of names accepted by `on()`, `once()`, and
+`removeListener()`.
+
+## What else is exported
+
+| Category | Exports |
+|---|---|
+| Layout components | `LayoutAxis`, `Legend`, `Annotation`, `Shape`, `Slider`, `UpdateMenu`, `Scene`, and the other component interfaces |
+| Config and image export | `Config`, `ToImgopts`, `DownloadImgopts`, `ToImageButtonOptions`, `ModeBarDefaultButtons`, `ModeBarButton`, `Icon` |
+| Enums | String-literal unions such as `TraceType`, `AxisType`, `Calendar`, `Dash`, `PatternShape`, `XRef`, `YRef`, `MarkerSymbol`, `HoverInfo` — use these instead of `string` to get narrowing on attribute values |
+| Shared sub-interfaces | `Font`, `ColorBar`, `HoverLabel`, `Pattern`, `Domain`, `LegendGroupTitle`, `TickFormatStops` |
+| Events | `PlotMouseEvent`, `PlotHoverEvent`, `PlotSelectionEvent`, `PlotRelayoutEvent`, `PlotRestyleEvent`, `LegendClickEvent`, `SliderChangeEvent`, `PlotlyEventName` |
+| Animation and frames | `AnimationOpts`, `Frame`, `Transition`, `TransitionEasing` |
+| Templates | `Template`, `TemplateFigure`, `ValidateTemplateResult` |
+| DOM and values | `PlotlyHTMLElement`, `Datum`, `TypedArray`, `Color`, `ColorScale` |
+
+`PlotType` is an alias for `TraceType`, so existing imports keep compiling. New code
+should prefer `TraceType`.
diff --git a/_posts/plotly_js/guides/whats-new-in-v4/2026-07-20-whats-new-in-v4.md b/_posts/plotly_js/guides/whats-new-in-v4/2026-07-20-whats-new-in-v4.md
new file mode 100644
index 000000000..cfbc916d4
--- /dev/null
+++ b/_posts/plotly_js/guides/whats-new-in-v4/2026-07-20-whats-new-in-v4.md
@@ -0,0 +1,1246 @@
+---
+description: Full details on new features and breaking changes in Plotly.js version 4.
+display_as: guide
+language: plotly_js
+layout: base
+name: What's New in Plotly.js v4
+order: 1
+page_type: u-guide
+permalink: javascript/guides/whats-new-in-v4/
+sitemap: false
+thumbnail: thumbnail/quiver-plot.jpg
+---
+# What's New in Plotly.js v4
+
+This page is a comprehensive reference for the new features and breaking
+changes in Plotly.js v4. For a quick checklist of code changes to update
+existing charts, see [Migrating to Plotly.js
+v4](/javascript/guides/migrating-to-v4/).
+
+## Contents
+
+**New capabilities**
+
+- [Quiver trace type](#quiver-trace-type)
+- [Share with Plotly Cloud](#share-with-plotly-cloud)
+- [MathJax v4 support](#mathjax-v4-support)
+- [Sankey node and link ordering](#sankey-node-and-link-ordering)
+- [Sankey flow direction](#sankey-flow-direction)
+- [Geo subplot zoom limits](#geo-subplot-zoom-limits)
+- [TypeScript types](#typescript-types)
+
+**New defaults**
+
+- [Map subplots auto-fit to data](#map-subplots-auto-fit-to-data)
+- [Geo subplots auto-fit by default](#geo-subplots-auto-fit-by-default)
+- [Overlaying axis `tickmode` defaults to `'sync'`](#overlaying-axis-tickmode-defaults-to-sync)
+- [`splom.axis.matches` default flipped to `true`](#splomaxismatches-default-flipped-to-true)
+- [Shape legend marker outlines honor `line.dash`](#shape-legend-marker-outlines-honor-line-dash)
+
+**Behavior and library changes**
+
+- [Color library swap](#color-library-swap)
+- [Country name lookup](#country-name-lookup)
+- [Scattermap icon defaults](#scattermap-icon-defaults)
+- [Geo `fitbounds` framing for antimeridian features](#geo-fitbounds-framing-for-antimeridian-features)
+- [Sankey layout algorithm update](#sankey-layout-algorithm-update)
+
+**Removed**
+
+- [Chart Studio APIs removed](#chart-studio-apis-removed)
+- [Mapbox traces and subplots removed](#mapbox-traces-and-subplots-removed)
+
+**Requirements**
+
+- [Minimum Node.js version](#minimum-nodejs-version)
+
+---
+
+## Quiver trace type
+
+*Implemented in [#7710](https://github.com/plotly/plotly.js/pull/7710).*
+
+Plotly.js now ships a `quiver` trace type for visualizing 2D vector fields as
+arrays of arrows. Arrows are placed at `(x, y)` coordinates and drawn with
+direction and magnitude from `(u, v)` components. See
+[Quiver Plots](/javascript/quiver-plots/) for runnable examples.
+
+```js
+Plotly.newPlot(gd, [{
+ type: 'quiver',
+ x: [0, 1, 2, 0, 1, 2],
+ y: [0, 0, 0, 1, 1, 1],
+ u: [1, 0.5, 0, 0.5, 0, -0.5],
+ v: [0, 0.5, 1, 0.5, 1, 0.5]
+}]);
+```
+
+
+
+### Positioning and sizing
+
+| Attribute | Values | Purpose |
+|---|---|---|
+| `x`, `y` | numeric arrays | Arrow anchor positions. |
+| `u`, `v` | numeric arrays | Vector components at each `(x, y)`. |
+| `anchor` | `'tail'` (default) / `'tip'` / `'center'` | Which point of the arrow sits at `(x, y)`. |
+| `sizemode` | `'scaled'` (default) / `'raw'` | Normalize arrow lengths against the maximum vector length + point density, or draw them at their raw magnitude. |
+| `sizeref` | number (default `1`) | Multiplier applied on top of `sizemode`. |
+| `anglemode` | `'data'` / `'paper'` | In `'data'`, angles are measured in data coordinates and change with axis zoom or non-uniform scaling; in `'paper'`, angles stay fixed in pixel space. |
+
+### Styling
+
+Arrow lines are styled through `marker.line.width` and `marker.line.dash`.
+`marker.arrowsize` scales the arrowhead relative to the line width — a value
+of `1` (default) gives a head about 3× the line width.
+
+### Coloring arrows by a scalar field
+
+Pass `marker.color` as an array (one value per arrow) together with the usual
+colorscale attributes (`marker.colorscale`, `marker.cmin`, `marker.cmax`,
+`marker.showscale`, `marker.colorbar`) to color each arrow by that scalar. If
+you enable a colorscale but don't supply a `marker.color` array, arrows are
+colored by their vector magnitude `|(u, v)|` instead. A single (non-array)
+`marker.color` paints every arrow that one color.
+
+```js
+{
+ type: 'quiver',
+ x: [/* … */], y: [/* … */],
+ u: [/* … */], v: [/* … */],
+ marker: {
+ color: [/* one value per arrow */],
+ colorscale: 'Viridis',
+ showscale: true
+ }
+}
+```
+
+### Selection
+
+Quiver supports box and lasso selection through the standard `selected` /
+`unselected` marker attributes and appears in the modebar selection buttons
+like other cartesian traces.
+
+### Example: wind field
+
+A larger example showing arrows colored by magnitude:
+
+
+
+---
+
+## Share with Plotly Cloud
+
+*Implemented in [#7802](https://github.com/plotly/plotly.js/pull/7802),
+[#7852](https://github.com/plotly/plotly.js/pull/7852),
+[#7854](https://github.com/plotly/plotly.js/pull/7854), and
+[#7909](https://github.com/plotly/plotly.js/pull/7909).*
+
+Plotly.js now offers a modebar button, labelled "Share chart…", which sends the
+current chart to [Plotly Cloud](https://cloud.plotly.com) to generate a shareable
+link. Sharing the chart opens Plotly Cloud in a new tab, where you can copy the
+sharing link and adjust visibility settings. A Plotly Cloud account is required.
+
+The button is enabled by default in v4:
+
+
+
+Clicking the button brings up a confirmation dialog, which names the destination
+and offers **Cancel** and **Share**:
+
+
+
+### Config
+
+The button is controlled by two config options:
+
+| Config option | Default | Purpose |
+|---|---|---|
+| `showSendToCloud` | `true` | Whether the "Share chart…" modebar button is rendered. |
+| `plotlyServerURL` | `'https://cloud.plotly.com/newchart'` | The endpoint the button posts to. Override to point at a self-hosted or alternate server. |
+
+Hide the button by setting `showSendToCloud: false`:
+
+```js
+Plotly.newPlot(gd, data, layout, {
+ showSendToCloud: false
+});
+```
+
+---
+
+## MathJax v4 support
+
+*Implemented in [#7898](https://github.com/plotly/plotly.js/pull/7898).*
+
+Plotly.js now supports **MathJax v3 and v4** for rendering LaTeX in labels,
+titles, and annotations. Support for **MathJax v2 has been dropped**.
+
+### What to do
+
+Loading MathJax v2 in the page? Upgrade to v3 or v4. Plotly math rendering
+uses the tex-svg component (`tex-svg.js`):
+```html
+
+
+
+
+```
+
+Note that the `?config=TeX-AMS-MML_SVG` URL suffix (used with MathJax v2) is
+no longer required starting with MathJax v3. Configuration is specified by linking
+directly to the desired JavaScript file, which is `tex-svg.js` for Plotly.js.
+
+Already on v3? No action required — your math expressions continue to render.
+
+---
+
+## Sankey node and link ordering
+
+*Implemented in [#7873](https://github.com/plotly/plotly.js/pull/7873).*
+
+Two new attributes let you override the automatic ordering that v4's d3-sankey
+algorithm applies (see [Node and Link
+Ordering](/javascript/sankey-diagram/#node-and-link-ordering)):
+
+| Attribute | Default | `'input'` value |
+|---|---|---|
+| `sankey.node.sort` | `'auto'` | Preserves the vertical order of nodes as given in `node.label`, disabling the layout's default y-axis reordering. |
+| `sankey.link.sort` | `'auto'` | Preserves the order in which links are given in `link.source` / `link.target`, disabling the layout's per-node link ordering. |
+
+Defaults reproduce v3 behavior, so no code change is needed on upgrade. Use
+`'input'` when you want a stable, deterministic ordering across renders —
+animation, side-by-side comparisons, or figures where the input order carries
+semantic meaning that the layout would otherwise obscure.
+
+```js
+Plotly.newPlot(gd, [{
+ type: 'sankey',
+ node: {
+ label: [/* … */],
+ sort: 'input'
+ },
+ link: {
+ source: [/* … */],
+ target: [/* … */],
+ value: [/* … */],
+ sort: 'input'
+ }
+}]);
+```
+
+The `sort` attribute is not honored on circular Sankey diagrams — those
+continue to use `d3-sankey-circular`, which has no equivalent hook.
+
+Same data, same code — only the `sort` value differs:
+
+| `sort: 'auto'` (default) | `sort: 'input'` |
+|---|---|
+|  |  |
+
+In this figure the source nodes are given as `[A, B, C, D]` and paired
+one-to-one with targets `[Z, Y, X, W]` — a maximally-crossed input. `'auto'`
+flips the source column to `D, C, B, A` so the primary flows run horizontally;
+`'input'` leaves both columns in the given order and preserves every crossing.
+
+---
+
+## Sankey flow direction
+
+*Implemented in [#7870](https://github.com/plotly/plotly.js/pull/7870).*
+
+A new `sankey.direction` attribute controls which way flows run along the
+`orientation` axis, so you can reverse a diagram without manually reversing
+your `link.source` / `link.target` data (see [Flow
+Direction](/javascript/sankey-diagram/#flow-direction)).
+
+| Attribute | Default | `'reversed'` value |
+|---|---|---|
+| `sankey.direction` | `'forward'` | Flips the flow along the `orientation` axis. |
+
+`direction` is orthogonal to the existing `orientation` attribute (`'h'` /
+`'v'`), giving four combinations:
+
+| `orientation` | `direction` | Result |
+|---|---|---|
+| `'h'` (default) | `'forward'` (default) | Sources on the left, targets on the right |
+| `'h'` | `'reversed'` | Sources on the right, targets on the left |
+| `'v'` | `'forward'` | Sources on top, targets on the bottom |
+| `'v'` | `'reversed'` | Sources on the bottom, targets on the top |
+
+The default (`'forward'`) reproduces v3 behavior, so no code change is needed
+on upgrade.
+
+```js
+Plotly.newPlot(gd, [{
+ type: 'sankey',
+ orientation: 'h',
+ direction: 'reversed', // sources on the right, targets on the left
+ node: {
+ label: [/* … */]
+ },
+ link: {
+ source: [/* … */],
+ target: [/* … */],
+ value: [/* … */]
+ }
+}]);
+```
+
+Node labels stay upright and readable in every combination — only the flow
+geometry mirrors.
+
+| `direction: 'forward'` (default) | `direction: 'reversed'` |
+|---|---|
+|  |  |
+
+---
+
+## Geo subplot zoom limits
+
+*Implemented in [#7371](https://github.com/plotly/plotly.js/pull/7371).*
+
+Geo subplots accept two new attributes for clamping interactive zoom (see
+[Limiting Zoom on Outline Maps](/javascript/map-view/#limiting-zoom-on-outline-maps)):
+
+| Attribute | Default | Effect |
+|---|---|---|
+| `layout.geo.projection.minscale` | `0` | Lower bound on zoom, expressed as a multiplier of `projection.scale`. `0` means no lower bound. |
+| `layout.geo.projection.maxscale` | `null` | Upper bound on zoom, expressed as a multiplier of `projection.scale`. `null` means no upper bound. |
+
+```js
+Plotly.newPlot(gd, [/* … */], {
+ geo: {
+ projection: {
+ scale: 1,
+ minscale: 0.5, // can't zoom out past 50% of base
+ maxscale: 4, // can't zoom in past 400% of base
+ },
+ },
+});
+```
+
+The defaults preserve v3 behavior — figures that don't set these attributes
+are unaffected.
+
+One init-time wrinkle: if `projection.scale` falls outside `[minscale,
+maxscale]`, Plotly now dispatches a synthetic zoom event on first plot to
+clamp it back into range. That emits a `plotly_relayout` event that v3
+wouldn't have fired. If you have a listener that distinguishes user-driven
+zooms from programmatic ones, make sure it tolerates a single extra event at
+startup for figures whose initial `projection.scale` is outside the configured
+bounds.
+
+---
+
+## TypeScript types
+
+*Implemented in [#7680](https://github.com/plotly/plotly.js/pull/7680) and
+[#7868](https://github.com/plotly/plotly.js/pull/7868).*
+
+Plotly.js now ships its own TypeScript type definitions. `package.json` points
+`"types"` at `lib/index.d.ts`, so the types are picked up automatically — no
+separate `@types/*` install is needed. See
+[Using Plotly.js with TypeScript](/javascript/guides/typescript/) for a
+task-oriented walkthrough.
+
+### Importing
+
+The package exports a default namespace, named exports, and a global `Plotly`
+namespace:
+
+```ts
+import Plotly from 'plotly.js';
+// or
+import * as Plotly from 'plotly.js';
+// or
+import { newPlot } from 'plotly.js';
+import type { Layout, Data, TraceType } from 'plotly.js';
+```
+
+A minimal typed example:
+
+```ts
+import { newPlot } from 'plotly.js';
+import type { Data, Layout } from 'plotly.js';
+
+const data: Data[] = [{ type: 'scatter', x: [1, 2, 3], y: [4, 5, 6] }];
+const layout: Partial = { title: { text: 'Demo' } };
+
+await newPlot(div, data, layout);
+```
+
+### What's exported
+
+**Trace data** — `Data` (the union of every trace's typed data object), plus
+per-trace interfaces like `ScatterData`, `BarData`, `HeatmapData`,
+`ChoroplethData`, etc. Each per-trace interface narrows on `type`, so using
+`Data[]` in your figure lets TypeScript pick the right trace shape from the
+literal `type` value:
+
+```ts
+const data: Data[] = [
+ { type: 'bar', x: ['a', 'b'], y: [1, 2] }, // checked as BarData
+ { type: 'scatter', x: [1, 2], mode: 'lines' }, // checked as ScatterData
+];
+```
+
+Other exports:
+
+| Category | Exports |
+|---|---|
+| Layout | `Layout` (the full layout interface), `LayoutAxis`, `Legend`, `Annotation`, `Shape`, `Slider`, `UpdateMenu`, `Scene`, and the rest of the component interfaces. Pass `Partial` to `newPlot` / `react` since most fields are optional. |
+| Config | `Config`, `ToImgopts`, `ToImageButtonOptions`, `DownloadImgopts`, `ModeBarDefaultButtons`, `ModeBarButton`, `Icon`. |
+| Trace/layout enums | String-literal unions like `TraceType`, `AxisType`, `Calendar`, `Dash`, `PatternShape`, `XRef`, `YRef`, `MarkerSymbol`, `HoverInfo`, etc. Use these instead of bare `string` to get narrowing on attribute values. |
+| Shared sub-interfaces | `Font`, `ColorBar`, `HoverLabel`, `Pattern`, `Domain`, `LegendGroupTitle`, `TickFormatStops`, etc. — used wherever the schema reuses the same sub-attribute tree. |
+| Events | `PlotMouseEvent`, `PlotHoverEvent`, `PlotSelectionEvent`, `PlotRelayoutEvent`, `PlotRestyleEvent`, `LegendClickEvent`, `SliderChangeEvent`, etc., plus `PlotlyEventName` for the union of event names accepted by `on()` / `once()` / `removeListener()`. |
+| Animation & frames | `AnimationOpts`, `Frame`, `Transition`, `TransitionEasing`. |
+| Templates | `Template` interface (and `TemplateFigure`, `ValidateTemplateResult` from the template utilities). |
+| DOM | `PlotlyHTMLElement` (the typed `Plotly.newPlot` graph div), `Datum`, `TypedArray`, `Color`, `ColorScale`. |
+
+### Notes on a few types
+
+**`Data` vs per-trace interfaces.** Prefer the `Data` union for figure
+literals (TypeScript discriminates on `type`); use the per-trace interface
+only when you have a value that is *guaranteed* to be one trace type — e.g. a
+helper that builds a `BarData` to push into a `Data[]`.
+
+**`Layout` is the input shape, not the resolved shape.** It mirrors what you
+pass to `newPlot`. The post-coerce internal shape used inside Plotly's own
+code (often called "FullLayout") is intentionally not exported. Likewise
+`Data` is the input shape; resolved trace state ("FullData") is internal.
+
+**`PlotType` is an alias for `TraceType`.** Both name the same string-literal
+union of trace type names; existing code that imports `PlotType` keeps
+compiling. New code should prefer `TraceType`.
+
+---
+
+## Map subplots auto-fit to data
+
+*Implemented in [#7884](https://github.com/plotly/plotly.js/pull/7884).*
+
+`map` subplots now auto-fit the view to fit the trace data. In v3, the same
+layout produced a world view centered at `(0, 0)` with `zoom: 1`, requiring
+the user to supply `center` and `zoom` (or drag/scroll) to see their data.
+
+```js
+Plotly.newPlot(gd, [{
+ type: 'scattermap',
+ lon: [-122.4, -73.9, -87.6],
+ lat: [37.8, 40.7, 41.9]
+}], {
+ map: { style: 'basic' }
+});
+// v3: map opens centered at (0, 0) at zoom 1
+// v4: map opens framed on the three cities
+```
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+Auto-fitting runs on the initial render and again on data-only updates
+(`Plotly.restyle` of `lon`/`lat`, `Plotly.addTraces`, `Plotly.deleteTraces`)
+whenever the user hasn't overridden the view. Once the user pans, zooms,
+rotates, or tilts the map — or explicitly sets `center` / `zoom` / `bearing` /
+`pitch` in the layout — auto-fitting steps aside and preserves the chosen view
+across further data changes.
+
+### Disabling auto-fitting
+
+There are two ways to disable auto-fitting:
+
+**Set `map.fitbounds: false`** — disables automatic auto-fitting and instead
+defaults to showing a map with center `(0, 0)` and zoom `1`, as in v3.
+
+```js
+{ map: { fitbounds: false } }
+```
+
+**Set `map.center` or `map.zoom` explicitly** — passing any value for
+`map.zoom` or `map.center` (including the defaults of `zoom: 1` or `center: {
+lon: 0, lat: 0 }`) is taken as a signal to follow the user provided values
+rather than choosing zoom and center via auto-fitting.
+
+```js
+// Keep the v3 world view:
+{ map: { center: { lon: 0, lat: 0 }, zoom: 1 } }
+```
+
+### Which traces contribute
+
+`scattermap` and `densitymap` traces are affected by this change.
+**`choroplethmap` traces skip auto-fitting** because their data contains
+geographic regions, whose bounding boxes must be computed differently. When a
+subplot contains a `choroplethmap` trace, auto-fitting is disabled and the
+defaults (`zoom: 1` and `center: { lon: 0, lat: 0 }`) are used.
+
+### Data that crosses the antimeridian
+
+For data that straddles the antimeridian (points on both sides of ±180°, in
+the middle of the Pacific Ocean), the auto-fit picks the compact crossing
+range rather than the long-way-around view. For example, `lon: [131.8855,
+-179]` frames as `[131.8855, 181]` (a ~49° span across the antimeridian)
+instead of the naive `[-179, 131.8855]` (~311° the wrong way).
+
+
+
+### `map.bounds` is unaffected
+
+The `map.bounds` layout attribute (which restricts panning) is a separate
+concern and continues to work as in v3. Auto-fitting computes the *initial*
+view; `bounds` constrains *interactive* view movement. Both can coexist.
+
+### Relationship to `layout.geo.fitbounds`
+
+Both `map` and `geo` subplots now expose a `fitbounds` layout attribute, but
+the shapes differ:
+
+| | `map.fitbounds` | `geo.fitbounds` |
+|---|---|---|
+| Type | enumerated | enumerated |
+| Values | `false` / `'locations'` | `false` / `'locations'` / `'geojson'` |
+| Default | `'locations'` | `'locations'` (was `false` in v3 — see [Geo subplots auto-fit by default](#geo-subplots-auto-fit-by-default)) |
+| Re-fits on data updates | yes, until user overrides view | yes, every render |
+
+Both accept `false` (disable auto-fit) and `'locations'` (fit to trace lon/lat
+data); `geo.fitbounds` additionally accepts `'geojson'` to frame the entire
+geojson feature set rather than just visible locations.
+
+---
+
+## Geo subplots auto-fit by default
+
+*Implemented in [#7895](https://github.com/plotly/plotly.js/pull/7895).*
+
+`layout.geo.fitbounds` now defaults to `'locations'` (v3 default: `false`).
+`geo` subplots — used by `scattergeo`, `choropleth`, and any other
+location-based geo trace — now auto-fit their initial view to fit the trace
+data, matching the behavior of `map` subplots. Figures that previously
+rendered the full world map (or the scope's default extent) now zoom to just
+the locations they plot.
+
+```js
+Plotly.newPlot(gd, [{
+ type: 'choropleth',
+ locations: ['CAN', 'MEX'],
+ z: [1, 2]
+}], {
+ // v3: full world map (fitbounds defaulted to false)
+ // v4: tight fit around Canada and Mexico (fitbounds now defaults to 'locations')
+});
+```
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+### Disabling auto-fitting
+
+There are two ways to disable auto-fitting:
+
+**Set `layout.geo.fitbounds: false`** — disables automatic auto-fitting and
+instead defaults to showing a map with center `(0, 0)` and scale `1`, as in
+v3.
+
+```js
+Plotly.newPlot(gd, [/* ... */], {
+ geo: { fitbounds: false } // world view / scope-default view, as in v3
+});
+```
+
+**Implicit:** setting `layout.center` or specific attributes under
+`layout.projection` will disable auto-fit for that figure. Which attributes
+count depends on the projection:
+
+| Projection kind | Projection-specific opt-out attributes |
+|---|---|
+| Any non-`world` scope (checked first, even if the projection is also clipped) | `center.lon`, `center.lat`, `projection.scale` |
+| World scope + clipped projection (orthographic, azimuthal equal area, etc.) | `center.lon`, `center.lat`, `projection.scale`, `projection.rotation.lon`, `projection.rotation.lat` |
+| World scope, non-clipped projection (miller, robinson, mercator, etc.) | `center.lon`, `center.lat`, `projection.scale`, `projection.rotation.lon` |
+
+In addition to the projection-specific set above, setting either
+`lonaxis.range` or `lataxis.range` always disables auto-fit for that figure,
+regardless of projection type. Even for projections where fitbounds doesn't
+overwrite the ranges directly, the fitted `center`/`scale` would visually
+override whatever framing the ranges imply, so we treat setting a range as
+opt-out intent.
+
+Under the v4 default this means figures that supplied their own view
+attributes in v3 continue to render with those attributes — no code change
+needed. Auto-fit only kicks in when none of the relevant attributes are set.
+
+```js
+Plotly.newPlot(gd, [/* ... */], {
+ geo: {
+ projection: { rotation: { lon: -75 } }
+ // fitbounds is implicitly false because rotation.lon is set
+ }
+});
+```
+
+This differs from v3, where `fitbounds: 'locations'` would overwrite any
+user-supplied view attributes. In v4 the two are treated as opt-in to
+different framing modes: auto-fit or explicit view.
+
+### Projections that don't participate in auto-fit
+
+Three projection types skip auto-fit and render with the schema default view
+even when `fitbounds` is unset (i.e., defaulted to `'locations'`):
+
+| Projection | Why it skips auto-fit |
+|---|---|
+| `'albers usa'` | A fixed composite projection with predetermined insets for Alaska and Hawaii; it has no `center` / `rotation` concept for fitbounds to target. |
+| `'craig'` and `'satellite'` | The internal scale heuristic that drives `fitbounds` compares data bounds against world bounds in the projected plane, which is unreliable for these projections' non-linear (and, for satellite, perspective-dependent) mapping. Auto-fit would zoom incorrectly, so v4 skips it. |
+
+For these projections `layout.geo.fitbounds` is silently forced to `false` in
+the resolved layout even if you leave it at the default. To fit locations
+under one of these projections, supply the view attributes yourself (`center`,
+`projection.rotation`, `projection.scale`, etc.).
+
+### Reset button behavior
+
+The modebar's Reset view button restores the auto-fit view when `fitbounds` is
+active, not the schema default. Prior to v4 there was no auto-fit default, so
+Reset simply restored the schema default; in v4 the initial view captured for
+reset is the fitted view.
+
+---
+
+## Overlaying axis `tickmode` defaults to `'sync'`
+
+*Implemented in [#7684](https://github.com/plotly/plotly.js/pull/7684).*
+
+An axis that overlays another axis (`layout.xaxis2.overlaying: 'x'`,
+`layout.yaxis2.overlaying: 'y'`, etc.) now defaults its `tickmode` to `'sync'`
+instead of `'auto'`. The overlay axis draws tick marks and gridlines at the
+same positions as its base axis, computing labels to match — rather than
+picking its own auto-fit tick positions.
+
+In v3 the two axes drew independent auto-tick grids, producing staggered
+gridlines that were hard to read and left no visual association between a
+gridline and a specific axis. Sync eliminates that overlap.
+
+```js
+Plotly.newPlot(gd, [
+ { y: [1, 3, 2], name: 'A' },
+ { y: [100, 300, 200], name: 'B', yaxis: 'y2' }
+], {
+ yaxis2: { overlaying: 'y', side: 'right' }
+ // v3: y2 picks its own ticks, producing a staggered grid
+ // v4: y2 places ticks at y's tick positions, with y2-range labels
+});
+```
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+### Exception: categorical / multicategory base axes
+
+When the overlaid (base) axis is `type: 'category'` or `'multicategory'`,
+`tickmode` continues to default to `'auto'` on the overlaying axis. Sync'ing
+tick positions to category slots is almost never the intent.
+
+### Opting out
+
+Set `tickmode: 'auto'` (or any other explicit value) on the overlaying axis to
+restore v3 behavior:
+
+```js
+{ yaxis2: { overlaying: 'y', side: 'right', tickmode: 'auto' } }
+```
+
+### Incidental bug fix
+
+`showexponent`, `showtickprefix`, and `showticksuffix` values of `'first'` and
+`'last'` were previously ignored on axes rendered with `tickmode: 'sync'`. Any
+workaround for that (e.g., forcing `'all'` on overlay axes) is no longer
+needed in v4.
+
+---
+
+## `splom.axis.matches` default flipped to `true`
+
+*Implemented in [#7843](https://github.com/plotly/plotly.js/pull/7843).*
+
+`splom` (scatter plot matrix) traces now default `axis.matches` to `true`.
+That means axes on the same row are linked, and axes in the same column are
+linked, so pan and zoom propagate through the matrix as a group. In v3 the
+default was `false`, so each cell had its own independent axes.
+
+Plotly Express has always set `matches: true` on generated splom plots, so
+this brings the raw Plotly.js default in line with what Express users
+already saw.
+
+```js
+Plotly.newPlot(gd, [{
+ type: 'splom',
+ dimensions: [/* … */]
+}]);
+// v3: pan/zoom on one cell only affects that cell's axes
+// v4: pan/zoom on one cell also pans/zooms every cell in the same row and column
+```
+
+### Opting out
+
+Set `axis.matches: false` explicitly to restore v3 behavior:
+
+```js
+{
+ type: 'splom',
+ dimensions: [/* … */],
+ xaxes: [{ matches: false }, /* … */],
+ yaxes: [{ matches: false }, /* … */]
+}
+```
+
+Or set `matches: false` per axis via `layout.xaxis`/`layout.yaxis` if you
+want to unlink specific axes only.
+
+---
+
+## Shape legend marker outlines honor `line.dash`
+
+*Implemented in [#7845](https://github.com/plotly/plotly.js/pull/7845).*
+
+Shapes rendered in the legend as filled markers (e.g. `type: 'rect'`,
+`'circle'`, or filled paths with `showlegend: true`) now draw the marker's
+outline using the shape's `line.dash` value. In v3 the marker outline was
+always solid regardless of the shape's dash style, so the swatch didn't match
+the shape on the plot. (Line-only shapes — `type: 'line'` — already drew their
+swatch dashed in v3; only the filled-marker path was hardcoded to solid.)
+
+```js
+Plotly.newPlot(gd, [], {
+ shapes: [{
+ type: 'rect',
+ x0: 0, x1: 1, y0: 0, y1: 1,
+ line: { dash: 'dot' },
+ fillcolor: 'rgba(200,0,0,0.2)',
+ showlegend: true,
+ }],
+});
+// v3: legend marker outline is solid
+// v4: legend marker outline is dotted, matching the on-plot shape
+```
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+---
+
+## Color library swap
+
+*Implemented in [#7536](https://github.com/plotly/plotly.js/pull/7536).*
+
+In v4, Plotly's internal color processing was switched from
+[tinycolor2](https://github.com/bgrins/TinyColor) to
+[color](https://github.com/Qix-/color). The new library is actively maintained
+and supports modern CSS Color 4 syntax, but a handful of behaviors changed in
+the process.
+
+### Color string inputs that no longer work
+
+**`hsv()` color strings are no longer accepted.**
+
+```js
+// Before
+{ marker: { color: 'hsv(200, 80%, 80%)' } }
+
+// After — convert to hsl, hwb, hex, or rgb
+{ marker: { color: 'hsl(200, 67%, 47%)' } }
+```
+
+A color in the unsupported format will fall back to the attribute's default.
+
+**`hsl()` / `hsla()` strings need percent units on saturation and lightness.**
+A color in the unsupported format will fall back to the attribute's default.
+
+```js
+// Before
+{ marker: { color: 'hsl(0, 100, 40)' } }
+
+// After — add the percent units
+{ marker: { color: 'hsl(0, 100%, 40%)' } }
+```
+
+**`rgb()` / `rgba()` strings with 0–1 decimal fractions are no longer
+rescaled.** In v3, Plotly detected all-fractional `rgb()` components and
+rescaled them from 0–1 to 0–255 before parsing; v4 removed that step and reads
+every component literally on the 0–255 scale, so the same string now renders
+near-black.
+
+```js
+// Before — v3 rescaled 0–1 fractions to 0–255
+'rgb(0.5, 0.5, 0.5)' // → rgb(128, 128, 128)
+
+// After — read literally on the 0–255 scale and rounded to the nearest integer
+'rgb(0.5, 0.5, 0.5)' // → rgb(1, 1, 1)
+```
+
+Convert any inputs of the form `rgb(0.5, 0.5, 0.5)` to `rgb(128, 128, 128)`
+(or any other supported color string) before passing them to Plotly.
+
+Rescaling only ever applied when *all* of `r`, `g`, `b` were fractional. A
+string like `rgb(255, 0.0, 0.0)` was never rescaled and still renders
+correctly (its `0.0` components round to `0`); a partly-fractional string such
+as `rgb(200, 0.5, 0.5)` now rounds each component to the nearest integer →
+`rgb(200, 1, 1)`.
+
+**Hex strings without a leading `#` are no longer accepted.**
+
+```js
+// Before — tinycolor accepted bare hex
+{ marker: { color: 'fff' } }
+
+// After — invalid and falls back to the attribute default; add the '#'
+{ marker: { color: '#fff' } }
+```
+
+These changes affect *string* colors only. Numeric color arrays used for color
+mapping (e.g. `marker.color: [1, 2, 3, 4]` with a `colorscale`) are unchanged
+and remain valid — those values are mapped through the colorscale, not parsed
+as literal colors.
+
+### Color computation output changes
+
+A handful of Plotly's derived colors shift by a few RGB units. Visible places
+where output shifts:
+
+| Where | Example |
+|---|---|
+| Heatmap auto-contrast text | Cells in the mid-luminance range flip between dark grey and white on colorscales like Viridis or Jet |
+| Auto-generated `insidetextfont` color on bars/waterfall | Same threshold shift around mid-luminance backgrounds |
+| Sankey default hover color (dark BG) | RGB channels shift by 1 unit per channel vs v3 |
+
+Example — the four cells with `z` values 55, 56, and 60 (both occurrences)
+shift their text from white in v3 to dark grey in v4 on a Viridis heatmap,
+because the underlying color library computes cell luminance with a slightly
+different formula.
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+### New color formats you can now use
+
+The new library adds CSS Color 4 syntax that tinycolor didn't fully support —
+notably slash-separated alpha and the `hwb()` color space:
+
+```js
+'rgba(255 0 0 / 0.5)' // space-separated rgb with slash alpha
+'hsl(0 100% 50% / 0.5)' // slash alpha on hsl (v3 accepted the syntax but dropped the alpha)
+'hwb(0 0% 0%)' // hwb (hue-whiteness-blackness)
+```
+
+Note that `hwb()` has no comma-separated form in CSS — the legacy syntax exists
+only for `rgb()` and `hsl()`.
+
+The following additional formats were already supported:
+
+- 8-digit hex (`#ff0000aa`)
+- 4-digit short hex (`#f00a`),
+- Space-separated `rgb(255 0 0)`
+- Comma-form `hsla(0, 100%, 50%, 0.5)`.
+
+See
+[test/image/mocks/color_syntax_formats.json](https://github.com/plotly/plotly.js/blob/master/test/image/mocks/color_syntax_formats.json)
+for a working example using each format.
+
+#### Browser compatibility
+
+All of these are parsed by Plotly in JavaScript and normalized to legacy
+`rgb(...)` / `rgba(...)` before being written to the DOM, so the browser never
+sees the modern syntax — your figures render the same in any browser that ran
+v3.
+
+---
+
+## Country name lookup
+
+*Implemented in [#7856](https://github.com/plotly/plotly.js/pull/7856).*
+
+`locationmode: 'country names'` on `choropleth` and `scattergeo` traces is now
+resolved by [country-iso-search](https://github.com/plotly/country-iso-search)
+instead of [country-regex](https://github.com/etpinard/country-regex). The
+attribute name, accepted values list, and ISO-3 output are unchanged — the
+difference is in *how* a name string is matched to an alpha-3 code.
+
+The old library walked a table of country-specific regular expressions and
+returned the first match. That made it lenient (substring matches worked) but
+ambiguity-prone — strings like `'Republic of'` could resolve to whichever
+entry's regex hit first. The new library does a sanitized exact lookup against
+a curated alias table, which is stricter about ambiguous input but accepts
+many more legitimate forms.
+
+### Previously recognized names that no longer work
+
+Strings that only matched because of overly broad regex fragments now fall
+back to the unrecognized-name log message and the location is skipped. In
+practice this hits inputs that weren't really country names — partial phrases,
+generic descriptors, or strings containing a country name as a substring of
+something else (e.g. `'Republic of Foo'`, `'Not Iran'`). If you were relying
+on a non-canonical form, switch to the country's name, an alias, or the ISO-3
+/ ISO-2 code.
+
+### Names and forms that now resolve
+
+The alias table is larger and the input is normalized before lookup, so a
+number of forms that previously failed now work:
+
+```js
+// All resolve to 'FRA'
+'France'
+'FR' // ISO 3166-1 alpha-2
+250 // UN M49 numeric (number or string)
+'\u{1F1EB}\u{1F1F7}' // flag emoji
+
+// Historical / native / punctuated names
+'Burma' // → 'MMR'
+'Türkiye' // → 'TUR' (diacritics stripped)
+'Cote d\'Ivoire' // → 'CIV' (apostrophes ignored)
+'St. Kitts and Nevis' // → 'KNA' ('St.' expands to 'Saint')
+'The Gambia' // → 'GMB' (leading 'The ' dropped)
+```
+
+Matching is case-insensitive. Sanitization also collapses internal whitespace,
+drops `.` `()` `,`, maps `&` → `and`, and turns `-` / `–` / `—` into spaces —
+so cosmetic punctuation differences in your input data no longer block a
+match.
+
+### Disputed-territory codes are retained
+
+The user-assigned alpha-3 codes Plotly historically recognized for disputed
+regions still work:
+
+| Code | Region |
+|---|---|
+| `XAC` | Aksai Chin |
+| `XAP` | Arunachal Pradesh |
+| `XBT` | Bir Tawil |
+| `XHT` | Halaib Triangle |
+| `XJK` | Jammu and Kashmir |
+
+These are layered on top of the standard ISO 3166-1 records via
+[src/lib/custom_country_codes.ts](https://github.com/plotly/plotly.js/blob/master/src/lib/custom_country_codes.ts).
+Whether a feature for them appears on the rendered map still depends on the
+topojson resolution in use.
+
+---
+
+## Scattermap icon defaults
+
+*Implemented in [#7825](https://github.com/plotly/plotly.js/pull/7825).*
+
+If you used `scattermap` or `scattermapbox` in v3, three rendering details
+have changed by the time you land on `scattermap` in v4:
+
+### Marker icons now respect `marker.color`
+
+`marker.color` on a scattermap trace is now applied to the icon by setting
+`icon-color`. In v3, the icons were always black.
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+### Maki icon set updated to v8 (via jsDelivr)
+
+The icon CDN and version have changed:
+
+| Version | URL |
+|---|---|
+| v3 | `https://unpkg.com/maki@2.1.0/icons/.svg` |
+| v4 | `https://cdn.jsdelivr.net/npm/@mapbox/maki@8.2.0/icons/.svg` |
+
+A handful of icon names removed between Maki 2.1 and 8.2 will now silently
+fail to load (HTTP 404). If you were using one of the dropped icons, swap it
+for the nearest Maki 8 equivalent (see [Maki 8 icon
+list](https://labs.mapbox.com/maki-icons/)).
+
+### Legend swatch always renders as a circle
+
+`scattermap` legend swatches now always draw a circle, regardless of
+`marker.symbol`. In v3 the swatch went through the same code path as cartesian
+traces, which only understands the [Plotly-supported symbol
+names](https://github.com/plotly/plotly.js/blob/master/src/components/drawing/symbol_defs.js).
+On map traces, that produced inconsistent output: symbols with names that
+don't overlap the Plotly set (Maki-only names like `'airport'`, `'cafe'`)
+rendered as filled circles, while other symbols (`'square'`, `'star'`, etc.)
+rendered as broken/empty paths in the legend even though they draw correctly
+on the map. The v4 circle fallback makes the swatch consistent across every
+scattermap trace.
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+If you were styling the legend swatch path directly based on `marker.symbol`,
+that selector will now always match a circle path on map traces.
+
+---
+
+## Geo `fitbounds` framing for antimeridian features
+
+*Implemented in [#7891](https://github.com/plotly/plotly.js/pull/7891).*
+
+`layout.geo.fitbounds: 'locations'` (and `'geojson'`) now correctly frames
+choropleth and scattergeo location traces containing features that cross the
+±180° antimeridian — Russia, Fiji, Antarctica, New Zealand, and the Aleutian
+Islands portion of Alaska. In v3 these were mis-framed because the underlying
+bounding-box computation (`@turf/bbox`) reported a bogus whole-globe span
+(`[-180°, 180°]`) for any such feature, and the fit zoomed the map out to
+match. In v4, `computeBbox` uses `d3-geo.geoBounds`' widest-gap longitude
+algorithm on the feature's vertices and returns the compact crossing range
+(with `east > 180°` when the range wraps).
+
+Because v4 also flips the `fitbounds` default from `false` to `'locations'`
+(see [Geo subplots auto-fit by default](#geo-subplots-auto-fit-by-default)),
+figures that never set `fitbounds` explicitly now participate in auto-fit too
+— so this antimeridian fix reaches many more figures than it would have as a
+standalone change.
+
+### Which figures shift
+
+A figure sees a visible change when **both** of the following hold:
+
+| Condition | Detail |
+|---|---|
+| `layout.geo.fitbounds` is active | Either explicitly set to `'locations'` / `'geojson'`, or left at the v4 default (see the opt-out list in the auto-fit-default section above). |
+| The figure contains an antimeridian-crossing feature | A `choropleth` or `scattergeo` trace with `locations` where at least one location resolves to a feature that crosses ±180°. |
+
+Figures that opt out of auto-fit (`fitbounds: false`, an explicit view
+attribute, or one of the projections listed as skipping auto-fit), or that
+don't include an antimeridian-crossing feature, render identically to v3 as
+far as this fix is concerned.
+
+### Example
+
+```js
+Plotly.newPlot(gd, [{
+ type: 'choropleth',
+ locations: ['RUS'],
+ z: [1],
+ colorscale: [[0, '#c33'], [1, '#c33']],
+ showscale: false
+}], {
+ geo: { fitbounds: 'locations', projection: { type: 'equirectangular' } },
+ width: 700,
+ height: 500
+});
+// v3: fits to a bogus [-180°, 180°] span — Russia is a small red strip at
+// the top of the whole world.
+// v4: fits tightly to Russia's actual longitudinal extent (~19° through
+// ~190°, unwrapped across the antimeridian).
+```
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+---
+
+## Sankey layout algorithm update
+
+*Implemented in [#7830](https://github.com/plotly/plotly.js/pull/7830).*
+
+`@plotly/d3-sankey` has been upgraded from 0.7.2 to 0.12.3. The schema and API
+surface for `sankey` traces are unchanged — every attribute that worked in v3
+still works in v4 — but the underlying layout algorithm was rewritten upstream
+across these versions, so node and link positions for the same figure shift.
+
+The most visible effect is that links tend to be straighter and cross each
+other less: the new relaxation step gives more weight to minimizing link
+travel between columns, so flows that previously swooped across the diagram
+now run closer to horizontal. Node y-positions within a column shift to
+accommodate this, and exact node heights / paddings can differ by a few
+pixels.
+
+| Before (v3) | After (v4) |
+|---|---|
+|  |  |
+
+---
+
+## Chart Studio APIs removed
+
+*Implemented in [#7812](https://github.com/plotly/plotly.js/pull/7812).*
+
+The legacy "Edit in Chart Studio" link, related config options, and the
+streaming token attribute have been removed. The `sendChartToCloud` modebar
+button (aliased as `sendDataToCloud` in v3, now targeting Plotly Cloud in v4;
+see [Share with Plotly Cloud](#share-with-plotly-cloud)) and its
+`showSendToCloud` config option are retained — only the duplicate
+`editInChartStudio` button and the on-graph "Edit chart" link are gone.
+
+### Removed config options
+
+`Plotly.newPlot(gd, data, layout, config)` no longer accepts:
+
+| Removed | What it did | Replacement |
+|---|---|---|
+| `showLink` | Drew an "Edit chart" link at the bottom-right of the plot | None — remove the option |
+| `linkText` | Text for the `showLink` link | None — remove the option |
+| `sendData` | Whether the link uploaded data or just linked to a file | None — remove the option |
+| `showSources` | Hook that drew custom source links next to `showLink` | None — remove the option |
+| `showEditInChartStudio` | Pencil-icon variant of `sendChartToCloud` | Use `showSendToCloud` |
+
+```js
+// Before
+Plotly.newPlot(gd, data, layout, {
+ showLink: true,
+ linkText: 'View on Plotly',
+ showEditInChartStudio: true,
+});
+
+// After
+Plotly.newPlot(gd, data, layout, {
+ showSendToCloud: true,
+});
+```
+
+### Removed modebar button
+
+`editInChartStudio` is no longer a built-in modebar button. If you were adding
+it explicitly via `modeBarButtonsToAdd`, switch to `sendChartToCloud`. Note
+that the v3 alias `sendDataToCloud` was **also** removed in v4, so code that
+referred to the button by that name needs to be updated too:
+
+```js
+// Before (v3 — both worked)
+{ modeBarButtonsToAdd: ['editInChartStudio'] }
+{ modeBarButtonsToAdd: ['sendDataToCloud'] }
+
+// After (v4)
+{ modeBarButtonsToAdd: ['sendChartToCloud'] }
+```
+
+### Removed trace attribute
+
+The undocumented `stream` attribute (`stream.token`, `stream.maxpoints`) has
+been removed from every trace type. It was a hook for the Chart Studio
+streaming service, which is no longer reachable. If you have figures
+containing `stream: { token: '...', maxpoints: N }` in their trace objects,
+delete those properties — they're now schema-rejected.
+
+### Removed data-source (`*src`) attributes
+
+*See [#7829](https://github.com/plotly/plotly.js/pull/7829).*
+
+Every schema attribute ending in `src` (`xsrc`, `ysrc`, `textsrc`,
+`marker.colorsrc`, ...) has been removed, along with `layout.hidesources`.
+These existed only to interoperate with Chart Studio's data-source
+references, which is no longer reachable. If your figures contain any
+`*src` attributes or `hidesources`, delete them — they're now schema-rejected.
+
+---
+
+## Mapbox traces and subplots removed
+
+*Implemented in [#7860](https://github.com/plotly/plotly.js/pull/7860).*
+
+The legacy Mapbox–based traces and subplot type have been removed. The
+equivalent MapLibre-based `map` traces (first released in Plotly.js v3) are
+now the only map implementation. For more information, see [Mapbox to
+MapLibre migration](https://plotly.com/python/mapbox-to-maplibre/).
+
+### Removed
+
+| Removed | Replacement |
+|---|---|
+| `scattermapbox` trace | `scattermap` |
+| `choroplethmapbox` trace | `choroplethmap` |
+| `densitymapbox` trace | `densitymap` |
+| `layout.mapbox` subplot (and `mapbox2`, `mapbox3`, …) | `layout.map` (and `map2`, `map3`, …) |
+| `layout.mapbox.accesstoken` | None — MapLibre uses open tile providers |
+| `mapboxAccessToken` config option | None — see above |
+| `plotly-mapbox.min.js` partial bundle | `plotly-map.min.js` |
+| Modebar buttons `zoomInMapbox`, `zoomOutMapbox`, `resetViewMapbox` | `zoomInMap`, `zoomOutMap`, `resetViewMap` |
+| `scrollZoom` flag value `'mapbox'` (e.g. `scrollZoom: 'mapbox+cartesian'`) | `'map'` |
+
+The attributes for `map` traces are identical to those of `mapbox` traces, so
+updating the trace name is all that's required to migrate.
+
+```js
+// Before
+{
+ data: [{ type: 'scattermapbox', lon: [...], lat: [...] }],
+ layout: {
+ mapbox: {
+ style: 'open-street-map',
+ center: { lon: 0, lat: 0 },
+ zoom: 2,
+ },
+ },
+ config: { mapboxAccessToken: 'pk.eyJ1...' },
+}
+
+// After
+{
+ data: [{ type: 'scattermap', lon: [...], lat: [...] }],
+ layout: {
+ map: {
+ style: 'open-street-map',
+ center: { lon: 0, lat: 0 },
+ zoom: 2,
+ },
+ },
+ // mapboxAccessToken no longer required
+}
+```
+
+### Built-in style values
+
+Every built-in `style` value supported for `mapbox` traces works for `map` traces as well,
+but the tile providers for some styles have changed. In those cases, the visual appearance
+of the map will differ:
+
+| Style name | Old (`mapbox`) | New (`map`) |
+|---|---|---|
+| `'basic'`, `'streets'`, `'outdoors'` | mapbox.com 'basic' / 'streets' / 'outdoors' tiles | [Carto](https://github.com/cartodb/basemap-styles/) Voyager |
+| `'light'` | mapbox.com 'light' tiles | [Carto](https://github.com/cartodb/basemap-styles/) Positron |
+| `'dark'` | mapbox.com 'dark' tiles | [Carto](https://github.com/cartodb/basemap-styles/) Dark Matter |
+| `'satellite'`, `satellite-streets` | mapbox.com satellite tiles | [ArcGIS World Imagery](https://server.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer) |
+| `'white-bg'` | solid white background | unchanged |
+| `'open-street-map'` | [OpenStreetMap](https://www.openstreetmap.org) tiles | unchanged |
+| `carto-*`, `carto-*-nolabels` | Corresponding [Carto](https://github.com/cartodb/basemap-styles/) tiles | unchanged |
+
+The three Stamen style values (`stamen-terrain`, `stamen-toner`, `stamen-watercolor`)
+are no longer supported, since Stamen tiles require a Stadia API key. It is still possible to use
+Stamen tiles, or any other third-party tiles, by passing the URL of a JSON style definition to `style`.
+
+### Custom style URLs
+
+Setting `style` to the URL of a MapLibre / Mapbox JSON style definition is still supported.
+Custom Mapbox URLs of the form `mapbox://styles/mapbox/...` are no longer supported, since they
+require authenticating to mapbox.com.
+
+---
+
+## Minimum Node.js version
+
+*Implemented in [#7861](https://github.com/plotly/plotly.js/pull/7861).*
+
+Plotly.js now requires Node.js v22 or newer. The previous minimum was v18, which
+has reached end-of-life.
+
+This only affects you if:
+
+| Scenario | Why |
+|---|---|
+| You build Plotly.js from source | Contributors and custom bundles |
+| You run Plotly.js in a Node.js runtime | Server-side rendering via jsdom, validation scripts, image export pipelines, etc. |
+| You install via `yarn` or `pnpm` | Both enforce `engines` strictly (`npm` prints a warning but installs) |
+
+Consumers who only load the pre-built browser bundle (`plotly.min.js` or a
+partial bundle like `plotly-basic.min.js`) are unaffected.
+
+If you're on Node 18 or 20, upgrade to 22 LTS. `npm` will print a warning on
+install but won't fail; `yarn` and `pnpm` will refuse to install unless your
+environment satisfies `engines.node >= 22.0.0`.
+
+---
diff --git a/_posts/plotly_js/maps/2019-07-03-outline-map-locations.html b/_posts/plotly_js/maps/2019-07-03-outline-map-locations.html
index 6da1cfee7..ba206c630 100644
--- a/_posts/plotly_js/maps/2019-07-03-outline-map-locations.html
+++ b/_posts/plotly_js/maps/2019-07-03-outline-map-locations.html
@@ -4,7 +4,7 @@
language: plotly_js
layout: base
name: Locations for Outline-based Maps
-order: 11
+order: 10
page_type: example_index
permalink: javascript/outline-map-locations/
thumbnail: thumbnail/choropleth.jpg
diff --git a/_posts/plotly_js/maps/bubble-maps/2015-07-11-bubble-map.html b/_posts/plotly_js/maps/bubble-maps/2015-07-11-bubble-map.html
index 42144cbe1..7edc2db44 100755
--- a/_posts/plotly_js/maps/bubble-maps/2015-07-11-bubble-map.html
+++ b/_posts/plotly_js/maps/bubble-maps/2015-07-11-bubble-map.html
@@ -32,7 +32,8 @@
var layout = {
'geo': {
'scope': 'europe',
- 'resolution': 50
+ 'resolution': 50,
+ 'fitbounds': false
}
};
diff --git a/_posts/plotly_js/maps/bubble-maps/2015-07-11-bubble_maps_plotlyjs_index.html b/_posts/plotly_js/maps/bubble-maps/2015-07-11-bubble_maps_plotlyjs_index.html
index 2effd4079..a0c1b669d 100755
--- a/_posts/plotly_js/maps/bubble-maps/2015-07-11-bubble_maps_plotlyjs_index.html
+++ b/_posts/plotly_js/maps/bubble-maps/2015-07-11-bubble_maps_plotlyjs_index.html
@@ -5,7 +5,7 @@
language: plotly_js
layout: base
name: Bubble Maps
-order: 6
+order: 5
page_type: example_index
permalink: javascript/bubble-maps/
redirect_from: javascript-graphing-library/bubble-maps/
diff --git a/_posts/plotly_js/maps/bubble-maps/2015-08-12-USA-bubble-map.html b/_posts/plotly_js/maps/bubble-maps/2015-08-12-USA-bubble-map.html
index 3ee9eae66..38c791f0d 100644
--- a/_posts/plotly_js/maps/bubble-maps/2015-08-12-USA-bubble-map.html
+++ b/_posts/plotly_js/maps/bubble-maps/2015-08-12-USA-bubble-map.html
@@ -61,6 +61,6 @@
},
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/choropleth-mapbox/2019-08-16-choropleth_plotly_js_index.html b/_posts/plotly_js/maps/choropleth-mapbox/2019-08-16-choropleth_plotly_js_index.html
index e759a0652..96df0f823 100644
--- a/_posts/plotly_js/maps/choropleth-mapbox/2019-08-16-choropleth_plotly_js_index.html
+++ b/_posts/plotly_js/maps/choropleth-mapbox/2019-08-16-choropleth_plotly_js_index.html
@@ -4,7 +4,7 @@
language: plotly_js
layout: base
name: Choropleth Tile Map
-order: 4
+order: 3
page_type: example_index
permalink: javascript/tile-county-choropleth/
redirect_from: javascript/mapbox-county-choropleth/
diff --git a/_posts/plotly_js/maps/choropleth-mapbox/2024-06-29-basic-mapbox.html b/_posts/plotly_js/maps/choropleth-mapbox/2024-06-29-basic-mapbox.html
deleted file mode 100644
index 0df34d165..000000000
--- a/_posts/plotly_js/maps/choropleth-mapbox/2024-06-29-basic-mapbox.html
+++ /dev/null
@@ -1,27 +0,0 @@
----
-name: Basic Tile using Mapbox
-language: plotly_js
-suite: tile-county-choropleth
-order: 4
-sitemap: false
-arrangement: horizontal
-markdown_content: |
-
- > Mapbox traces are deprecated and may be removed in a future version of Plotly.js.
-
- Earlier examples use traces that render with [Maplibre GL JS](https://maplibre.org/maplibre-gl-js/docs/).
- These traces were introduced in Plotly.js 2.35.0 and replace Mapbox-based tile maps,
- which are now deprecated. Here's one of the earlier examples using the Mapbox-based `choroplethmapbox` trace
----
-
-var data = [{
- type: "choroplethmapbox", locations: ["NY", "MA", "VT"], z: [-50, -10, -20],
- geojson: "https://raw.githubusercontent.com/python-visualization/folium/master/examples/data/us-states.json"
-}];
-
-var layout = {mapbox: {center: {lon: -74, lat: 43}, zoom: 3.5},
- width: 600, height:400};
-
-var config = {mapboxAccessToken: "your access token"};
-
-Plotly.newPlot('myDiv', data, layout, config);
\ No newline at end of file
diff --git a/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth-north-america.html b/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth-north-america.html
index 2568e1e4d..520ac94ed 100755
--- a/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth-north-america.html
+++ b/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth-north-america.html
@@ -44,5 +44,5 @@
}
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth-world-robinson.html b/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth-world-robinson.html
index 07b25c214..13d889851 100755
--- a/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth-world-robinson.html
+++ b/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth-world-robinson.html
@@ -28,5 +28,5 @@
}
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth_plotly_js_index.html b/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth_plotly_js_index.html
index 60cce827f..f8aeed399 100755
--- a/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth_plotly_js_index.html
+++ b/_posts/plotly_js/maps/choropleth-maps/2015-07-11-choropleth_plotly_js_index.html
@@ -5,7 +5,7 @@
language: plotly_js
layout: base
name: Choropleth Maps
-order: 9
+order: 8
permalink: javascript/choropleth-maps/
redirect_from: javascript-graphing-library/choropleth-maps/
thumbnail: thumbnail/choropleth.jpg
diff --git a/_posts/plotly_js/maps/choropleth-maps/2015-08-10-countrygdp-choropleth-map.html b/_posts/plotly_js/maps/choropleth-maps/2015-08-10-countrygdp-choropleth-map.html
index 4ab8a485f..e1faa7781 100644
--- a/_posts/plotly_js/maps/choropleth-maps/2015-08-10-countrygdp-choropleth-map.html
+++ b/_posts/plotly_js/maps/choropleth-maps/2015-08-10-countrygdp-choropleth-map.html
@@ -48,5 +48,5 @@
}
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/choropleth-maps/2015-08-11-US-pop-by-state-choropleth.html b/_posts/plotly_js/maps/choropleth-maps/2015-08-11-US-pop-by-state-choropleth.html
index 798840157..7d8c28531 100644
--- a/_posts/plotly_js/maps/choropleth-maps/2015-08-11-US-pop-by-state-choropleth.html
+++ b/_posts/plotly_js/maps/choropleth-maps/2015-08-11-US-pop-by-state-choropleth.html
@@ -34,5 +34,5 @@
}
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/density-mapbox/2019-08-16-basic_density_mapbox.html b/_posts/plotly_js/maps/density-mapbox/2019-08-16-basic_density_mapbox.html
index 6c168a371..4881cf80e 100755
--- a/_posts/plotly_js/maps/density-mapbox/2019-08-16-basic_density_mapbox.html
+++ b/_posts/plotly_js/maps/density-mapbox/2019-08-16-basic_density_mapbox.html
@@ -1,5 +1,5 @@
---
-name: Stamen Terrain Tile
+name: Custom Tile Style
language: plotly_js
suite: tile-density-heatmaps
order: 5
@@ -8,10 +8,24 @@
arrangement: horizontal
markdown_content: |
+ As well as the built-in style names, `layout.map.style` accepts the URL of any
+ [MapLibre style definition](https://maplibre.org/maplibre-style-spec/). The example below points at Carto's Positron
+ style JSON directly.
+ Some providers require an API key, which you append to the style URL. The `stamen-terrain`, `stamen-toner`, and
+ `stamen-watercolor` style names are not built in for this reason: Stamen tiles are served by
+ [Stadia Maps](https://stadiamaps.com/), which requires an account. To use them, sign up and add your own key:
+
+ ```
+ map: {style: 'https://tiles.stadiamaps.com/styles/stamen_watercolor.json?api_key=YOUR_STADIA_KEY'}
+ ```
---
-var data = [{type: 'densitymapbox', lon: [10, 20, 30], lat: [15, 25, 35], z: [1, 3, 2]}];
+var data = [{type: 'densitymap', lon: [10, 20, 30], lat: [15, 25, 35], z: [1, 3, 2]}];
-var layout = {width: 600, height: 400, mapbox: {style: 'https://tiles.stadiamaps.com/styles/stamen_watercolor.json?api_key=YOUR-API-KEY'}};
+var layout = {
+ width: 600,
+ height: 400,
+ map: {style: 'https://basemaps.cartocdn.com/gl/positron-gl-style/style.json'}
+};
Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/maps/density-mapbox/2019-08-16-density_plotly_js_index.html b/_posts/plotly_js/maps/density-mapbox/2019-08-16-density_plotly_js_index.html
index 7bc025f88..4b6921182 100755
--- a/_posts/plotly_js/maps/density-mapbox/2019-08-16-density_plotly_js_index.html
+++ b/_posts/plotly_js/maps/density-mapbox/2019-08-16-density_plotly_js_index.html
@@ -5,7 +5,7 @@
language: plotly_js
layout: base
name: Tile Density Heatmap
-order: 3
+order: 2
page_type: example_index
permalink: javascript/tile-density-heatmaps/
redirect_from: javascript/mapbox-density-heatmaps/
diff --git a/_posts/plotly_js/maps/density-mapbox/2019-08-16-light-tile-mapbox.html b/_posts/plotly_js/maps/density-mapbox/2019-08-16-light-tile-mapbox.html
deleted file mode 100755
index ed0cd3576..000000000
--- a/_posts/plotly_js/maps/density-mapbox/2019-08-16-light-tile-mapbox.html
+++ /dev/null
@@ -1,27 +0,0 @@
----
-name: Light Tile (Mapbox) - Requires Token
-language: plotly_js
-layout: base
-suite: tile-density-heatmaps
-order: 7
-sitemap: false
-arrangement: horizontal
-markdown_content: |
- **Mapbox traces are deprecated and may be removed in a future version of Plotly.js.**
-
- Earlier examples use traces that render with [Maplibre GL JS](https://maplibre.org/maplibre-gl-js/docs/).
- These traces were introduced in Plotly.js 2.35.0 and replace Mapbox-based tile maps,
- which are now deprecated. Here's one of the earlier examples written using the Mapbox-based `densitymapbox` trace.
----
-var data = [
- {type: "densitymapbox", lon: [10, 20, 30], lat: [15, 25, 35], z: [1, 3, 2],
- radius: 50, colorbar: {y: 1, yanchor: 'top', len: 0.45}},
- {type: 'densitymapbox', lon: [-10, -20, -30], lat: [15, 25, 35],
- radius: [50, 100, 10], colorbar: {y: 0, yanchor: 'bottom', len: 0.45}
- }];
-
-var layout = {mapbox: {style: 'light', center: {lat: 20}}, width: 600, height: 400};
-
-var config = {mapboxAccessToken: "your access token"};
-
-Plotly.newPlot('myDiv', data, layout, config);
diff --git a/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-access-token.html b/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-access-token.html
index dd3da713d..e60957f3d 100644
--- a/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-access-token.html
+++ b/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-access-token.html
@@ -27,7 +27,7 @@
Filled `Scattermap` Trace
var layout = {
map: {
- style: "stamen-terrain",
+ style: "open-street-map",
center: { lon: -73, lat: 46 },
zoom: 5
},
diff --git a/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-fill-area_plotly_js_index.html b/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-fill-area_plotly_js_index.html
index 2f563f4bf..1a98cefc7 100644
--- a/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-fill-area_plotly_js_index.html
+++ b/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-fill-area_plotly_js_index.html
@@ -5,7 +5,7 @@
language: plotly_js
layout: base
name: Filled Area on Tile Maps
-order: 10
+order: 9
page_type: u-guide
permalink: javascript/filled-area-on-map/
redirect_from: javascript/filled-area-on-mapbox/
diff --git a/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-multi-filled-area.html b/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-multi-filled-area.html
index 600fa264e..374f41ea0 100644
--- a/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-multi-filled-area.html
+++ b/_posts/plotly_js/maps/fill-area-on-mapbox/2019-09-02-multi-filled-area.html
@@ -18,7 +18,7 @@
}]
var layout = {
- map: {style: "stamen-terrain", center: {lon: 40, lat: 20}, 'zoom': 1.5},
+ map: {style: "open-street-map", center: {lon: 40, lat: 20}, 'zoom': 1.5},
showlegend: false,
width:700, height: 700}
diff --git a/_posts/plotly_js/maps/lines-on-maps/2015-07-11-lines_on_maps_plotly_js_index.html b/_posts/plotly_js/maps/lines-on-maps/2015-07-11-lines_on_maps_plotly_js_index.html
index b22ea5ada..d758b1651 100755
--- a/_posts/plotly_js/maps/lines-on-maps/2015-07-11-lines_on_maps_plotly_js_index.html
+++ b/_posts/plotly_js/maps/lines-on-maps/2015-07-11-lines_on_maps_plotly_js_index.html
@@ -6,7 +6,7 @@
language: plotly_js
layout: base
name: Lines on Maps
-order: 5
+order: 4
page_type: example_index
permalink: javascript/lines-on-maps/
redirect_from: javascript-graphing-library/lines-on-maps/
diff --git a/_posts/plotly_js/maps/lines-on-maps/2015-08-12-us-flight-paths-map.html b/_posts/plotly_js/maps/lines-on-maps/2015-08-12-us-flight-paths-map.html
index 153c32d5c..544ef4e10 100644
--- a/_posts/plotly_js/maps/lines-on-maps/2015-08-12-us-flight-paths-map.html
+++ b/_posts/plotly_js/maps/lines-on-maps/2015-08-12-us-flight-paths-map.html
@@ -45,6 +45,7 @@
showlegend: false,
geo:{
scope: 'north america',
+ fitbounds: false,
projection: {
type: 'azimuthal equal area'
},
@@ -54,6 +55,6 @@
}
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/lines-on-maps/2015-11-07-lines-on-orthographic.html b/_posts/plotly_js/maps/lines-on-maps/2015-11-07-lines-on-orthographic.html
index 53767f2a2..5226d6dc1 100755
--- a/_posts/plotly_js/maps/lines-on-maps/2015-11-07-lines-on-orthographic.html
+++ b/_posts/plotly_js/maps/lines-on-maps/2015-11-07-lines-on-orthographic.html
@@ -68,5 +68,5 @@
}
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/map-view/2026-08-04-geo-autofit.html b/_posts/plotly_js/maps/map-view/2026-08-04-geo-autofit.html
new file mode 100644
index 000000000..8370f91d1
--- /dev/null
+++ b/_posts/plotly_js/maps/map-view/2026-08-04-geo-autofit.html
@@ -0,0 +1,41 @@
+---
+name: Auto-Fitting an Outline Map
+language: plotly_js
+suite: map-view
+order: 3
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ `layout.geo.fitbounds` defaults to `'locations'`, so an outline map frames the locations it plots rather than the
+ whole world. Set `fitbounds: false` to get the pre-v4 world view, or supply your own view attributes — `center`
+ and `projection.scale` always turn auto-fitting off, and `projection.rotation`, `lonaxis.range`, and
+ `lataxis.range` do too except on a scoped subplot with a clipped projection. See
+ [Map View and Zoom](/javascript/map-view/) for the full breakdown.
+
+ When `fitbounds` is active, the modebar's Reset view button returns to the fitted view rather than the world view.
+
+ Note that a location whose territory crosses the ±180° antimeridian — the United States (the Aleutian Islands),
+ Russia, Fiji, New Zealand, and Antarctica — spans most of the globe's longitude, so a figure that includes one is
+ fitted very wide. Set the view explicitly in that case.
+---
+var data = [{
+ type: 'choropleth',
+ locations: ['BRA', 'ARG', 'CHL', 'PER', 'COL', 'BOL'],
+ locationmode: 'ISO-3',
+ z: [6, 5, 4, 3, 2, 1],
+ colorscale: 'Blues',
+ showscale: false
+}];
+
+var layout = {
+ title: {text: 'Fitted to the Plotted Locations'},
+ geo: {
+ projection: {type: 'equirectangular'},
+ showcountries: true,
+ countrycolor: 'rgb(255, 255, 255)'
+ },
+ width: 700,
+ height: 450
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/maps/map-view/2026-08-04-geo-zoom-limits.html b/_posts/plotly_js/maps/map-view/2026-08-04-geo-zoom-limits.html
new file mode 100644
index 000000000..329a46961
--- /dev/null
+++ b/_posts/plotly_js/maps/map-view/2026-08-04-geo-zoom-limits.html
@@ -0,0 +1,48 @@
+---
+name: Limiting Zoom on Outline Maps
+language: plotly_js
+suite: map-view
+order: 4
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ `projection.minscale` and `projection.maxscale`, new in Plotly.js v4, clamp how far users can zoom a `geo` subplot.
+ Both are multipliers of `projection.scale`: `minscale: 0.5` stops zooming out past half the base scale and
+ `maxscale: 4` stops zooming in past four times it. The defaults — `minscale: 0` and no `maxscale` — leave zoom
+ unrestricted.
+
+ Try scrolling on the map below: it will not zoom out below half, or in beyond four times, its initial scale.
+
+ If the initial `projection.scale` falls outside the range you set, Plotly clamps it on the first render by dispatching
+ a zoom event, which emits one extra `plotly_relayout`. Listeners that distinguish user zooms from programmatic ones
+ should tolerate that single event at startup.
+---
+var data = [{
+ type: 'scattergeo',
+ mode: 'markers+text',
+ lon: [2.35, 13.4, 12.5, -3.7],
+ lat: [48.86, 52.52, 41.9, 40.42],
+ text: ['Paris', 'Berlin', 'Rome', 'Madrid'],
+ textposition: 'top center',
+ marker: {size: 10, color: '#636efa'}
+}];
+
+var layout = {
+ title: {text: 'Zoom Limited to 0.5x - 4x'},
+ geo: {
+ scope: 'europe',
+ resolution: 50,
+ showland: true,
+ landcolor: 'rgb(235, 235, 235)',
+ projection: {
+ scale: 1,
+ minscale: 0.5,
+ maxscale: 4
+ }
+ },
+ showlegend: false,
+ width: 700,
+ height: 500
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/maps/map-view/2026-08-04-map-view_plotly_js_index.html b/_posts/plotly_js/maps/map-view/2026-08-04-map-view_plotly_js_index.html
new file mode 100644
index 000000000..700920a6c
--- /dev/null
+++ b/_posts/plotly_js/maps/map-view/2026-08-04-map-view_plotly_js_index.html
@@ -0,0 +1,57 @@
+---
+description: How to control the initial view of maps in JavaScript. Examples of auto-fitting a map to its data, setting an explicit view, and limiting how far users can zoom.
+display_as: maps
+language: plotly_js
+layout: base
+name: Map View and Zoom
+order: 11
+page_type: example_index
+permalink: javascript/map-view/
+thumbnail: thumbnail/county-level-choropleth.jpg
+---
+
+
Since Plotly.js v4, both outline-based geo subplots and tile-based map subplots auto-fit
+their initial view to the data they plot. Before v4, both opened on a default world view and you had to supply a view
+yourself to frame your data.
+
+
Auto-fitting is controlled by fitbounds:
+
+
+
layout.geo.fitbounds defaults to 'locations' and also accepts
+ 'geojson' (to frame the whole GeoJSON feature set rather than just the visible locations) and
+ false.
+
layout.map.fitbounds defaults to 'locations' and accepts false.
+ choroplethmap traces do not participate in auto-fitting, so a subplot containing one opens on the
+ default view.
+
+
+
Supplying your own view attributes turns auto-fitting off for that subplot. On a tile map that means
+map.center or map.zoom. On an outline map, which attributes count depends on the subplot:
the above, plus projection.rotation.lon, lonaxis.range,
+ lataxis.range
+
+
+
+
Note the first row: on a scoped subplot whose projection is clipped, lonaxis.range and
+lataxis.range do not turn auto-fitting off — they still clip the drawing region, but the view is
+centered on the data. Set fitbounds: false to honor the ranges as the view.
+
+
Setting fitbounds: false without supplying a view restores the pre-v4 default view. The
+'albers usa', 'craig', and 'satellite' projections never auto-fit.
+
+{% assign examples = site.posts | where:"language","plotly_js" | where:"suite","map-view" | sort: "order" %}
+{% include posts/auto_examples.html examples=examples %}
diff --git a/_posts/plotly_js/maps/map-view/2026-08-04-tile-map-autofit.html b/_posts/plotly_js/maps/map-view/2026-08-04-tile-map-autofit.html
new file mode 100644
index 000000000..f85aa63a1
--- /dev/null
+++ b/_posts/plotly_js/maps/map-view/2026-08-04-tile-map-autofit.html
@@ -0,0 +1,32 @@
+---
+name: Auto-Fitting a Tile Map to Data
+language: plotly_js
+suite: map-view
+order: 1
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ With no `center` or `zoom` given, a `map` subplot frames the trace data on the first render. It re-fits when the data
+ changes — through `Plotly.restyle` of `lon`/`lat`, `Plotly.addTraces`, or `Plotly.deleteTraces` — until the user pans,
+ zooms, rotates, or tilts the map, after which the chosen view is preserved. Data that straddles the antimeridian is
+ framed the short way around, not across the whole globe.
+---
+var data = [{
+ type: 'scattermap',
+ mode: 'markers+text',
+ lon: [-122.4, -73.9, -87.6],
+ lat: [37.8, 40.7, 41.9],
+ text: ['San Francisco', 'New York', 'Chicago'],
+ textposition: 'top right',
+ marker: {size: 12, color: '#d62728'}
+}];
+
+var layout = {
+ map: {style: 'basic'},
+ showlegend: false,
+ width: 700,
+ height: 450,
+ margin: {t: 30, b: 0, l: 0, r: 0}
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/maps/map-view/2026-08-04-tile-map-explicit-view.html b/_posts/plotly_js/maps/map-view/2026-08-04-tile-map-explicit-view.html
new file mode 100644
index 000000000..9b0fe4efe
--- /dev/null
+++ b/_posts/plotly_js/maps/map-view/2026-08-04-tile-map-explicit-view.html
@@ -0,0 +1,37 @@
+---
+name: Setting an Explicit Tile Map View
+language: plotly_js
+suite: map-view
+order: 2
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ Passing `map.center` or `map.zoom` opts the subplot out of auto-fitting and opens it on exactly the view you give,
+ even if that view is the default `zoom: 1` centered on `(0, 0)`. Setting `map.fitbounds: false` without a view has
+ the same effect as the pre-v4 default: a world view at `zoom: 1`.
+
+ `map.bounds`, which restricts how far users can pan, is independent of auto-fitting and can be combined with either.
+---
+var data = [{
+ type: 'scattermap',
+ mode: 'markers+text',
+ lon: [-122.4, -73.9, -87.6],
+ lat: [37.8, 40.7, 41.9],
+ text: ['San Francisco', 'New York', 'Chicago'],
+ textposition: 'top right',
+ marker: {size: 12, color: '#d62728'}
+}];
+
+var layout = {
+ map: {
+ style: 'basic',
+ center: {lon: -98, lat: 39},
+ zoom: 2.5
+ },
+ showlegend: false,
+ width: 700,
+ height: 450,
+ margin: {t: 30, b: 0, l: 0, r: 0}
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/maps/mapbox-layers/2019-08-16-access-token.html b/_posts/plotly_js/maps/mapbox-layers/2019-08-16-access-token.html
deleted file mode 100644
index aa232bf04..000000000
--- a/_posts/plotly_js/maps/mapbox-layers/2019-08-16-access-token.html
+++ /dev/null
@@ -1,29 +0,0 @@
----
-name: Mapbox Maps and Access Tokens
-language: plotly_js
-suite: map-layers
-order: 10
-sitemap: false
-arrangement: horizontal
-markdown_content: |
-
- > Mapbox traces are deprecated and may be removed in a future version of Plotly.js.
-
- The word "mapbox" in the trace names and `layout.mapbox` refers to the Mapbox GL JS open-source library.
- 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.
- If your basemap uses data 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.
-
- To use a token, provide it as `mapboxAccessToken` in the `setPlotConfig` function, or as a variable that would be passed as an argument of `newPlot`.
- If your `layout.mapbox.style` does not use data from the Mapbox service, you do *not* need to register for a Mapbox account.
-
Base Maps in `layout.mapbox.style`
- The accepted values for `layout.mapbox.style` are one of the following tiles.
-
-
`"white-bg"` yields an empty white canvas which results in no external HTTP requests
-
`"open-street-map"`, `"carto-positron"`, or `"carto-darkmatter"` yield maps composed of *raster* tiles from various public tile servers which do not require signups or access tokens
-
`"stamen-terrain"`, `"stamen-toner"` or `"stamen-watercolor"` yield maps composed of *raster* tiles from the [Stadia Maps service](https://stadiamaps.com/) and require a Stadia Maps account and token.
-
`"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.
-
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.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).
+
Base maps in `layout.map.style`
+
+ None of the built-in base maps require an account or an access token. The accepted values are:
+
+
`"white-bg"` yields an empty white canvas, which makes no external HTTP requests
+
`"open-street-map"` yields raster tiles from [OpenStreetMap](https://www.openstreetmap.org)
+
`"basic"`, `"streets"`, `"outdoors"`, `"light"`, `"dark"`, `"satellite"`, and `"satellite-streets"` yield vector tiles from [Carto](https://github.com/cartodb/basemap-styles/) and [ArcGIS](https://server.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer)
+
`"carto-positron"`, `"carto-darkmatter"`, `"carto-voyager"`, and their `-nolabels` variants yield the corresponding [Carto](https://github.com/cartodb/basemap-styles/) tiles
+
The URL of a [MapLibre style definition](https://maplibre.org/maplibre-style-spec/), for any other provider. Some providers require an API key, which you append to the style URL — Stamen tiles, for example, are served by [Stadia Maps](https://stadiamaps.com/) and need a Stadia account
+
A Map Style object, of the form described in the [MapLibre GL JS documentation](https://maplibre.org/maplibre-style-spec/)
With the release of Plotly.js v2.35.0, we are introducing a new set of trace types for maps with tile underlays:
+
Plotly.js v2.35.0 introduced a set of trace types for maps with tile underlays:
-
Choroplethmap
-
Scattermap
-
Densitymap
+
Choroplethmap
+
Scattermap
+
Densitymap
-
These traces replace the existing Mapbox traces, Choroplethmapbox, Scattermapbox,
- Densitymapbox, but use MapLibre as the map renderer rather than
+
These traces replace the Mapbox traces, Choroplethmapbox, Scattermapbox, and
+ Densitymapbox, and use MapLibre as the map renderer rather than
Mapbox.
+
The Mapbox traces, the layout.mapbox subplot, and the mapboxAccessToken config
+ option were removed in Plotly.js v4, along with the plotly-mapbox.min.js partial bundle and
+ the zoomInMapbox, zoomOutMapbox, and resetViewMapbox modebar buttons (use
+ plotly-map.min.js and zoomInMap, zoomOutMap, resetViewMap).
+ If you are upgrading to v4, follow the steps below first. See
+ Migrating to Plotly.js v4 for the rest of the upgrade.
+
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.
@@ -48,9 +55,14 @@
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.
+ provided by other tools. The three Stamen styles (stamen-terrain, stamen-toner, and
+ stamen-watercolor) are not available, because Stamen tiles are served by Stadia Maps and require
+ an API key — pass the URL of a style definition to use them.
+
Remove mapboxAccessToken from your config, and any
+ mapbox://styles/mapbox/... style URLs, neither of which is supported. Custom MapLibre and Mapbox
+ JSON style URLs still work.
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.
\ No newline at end of file
+ maps remains supported with the existing API.
diff --git a/_posts/plotly_js/maps/outline-map-locations/2019-07-03-country-names-example.html b/_posts/plotly_js/maps/outline-map-locations/2019-07-03-country-names-example.html
index 0284c4109..4e358366f 100644
--- a/_posts/plotly_js/maps/outline-map-locations/2019-07-03-country-names-example.html
+++ b/_posts/plotly_js/maps/outline-map-locations/2019-07-03-country-names-example.html
@@ -7,6 +7,13 @@
arrangement: horizontal
markdown_content: |
Set `locationmode: 'country names'` to use full country names in `locations`.
+
+ Names are resolved by [country-iso-search](https://github.com/plotly/country-iso-search), which matches a country's
+ name, its ISO-2 and UN M49 codes, and a curated set of aliases — historical and native names, and common alternates.
+ Matching ignores case, accents, and punctuation, so `'Cote d'Ivoire'`, `'Türkiye'`, and `'St. Kitts and Nevis'` all
+ resolve. See the library's
+ [country list](https://github.com/plotly/country-iso-search/blob/main/src/countries.ts) for every accepted name and
+ alias. A name that doesn't resolve is logged to the console and that location is skipped.
---
var data = [{
type: 'choropleth',
diff --git a/_posts/plotly_js/maps/outline-map-locations/2019-07-03-country-names-warning.html b/_posts/plotly_js/maps/outline-map-locations/2019-07-03-country-names-warning.html
deleted file mode 100644
index d243f2a1e..000000000
--- a/_posts/plotly_js/maps/outline-map-locations/2019-07-03-country-names-warning.html
+++ /dev/null
@@ -1,10 +0,0 @@
----
-language: plotly_js
-suite: outline-map-locations
-order: 3.5
-sitemap: false
-arrangement: horizontal
-markdown_content: |
- > How Plotly matches 'country names' will change in a future version. Matching will become stricter and some country names may no longer match. We recommend using `locationmode: 'ISO-3'` with ISO codes for `locations` to ensure consistent behavior across versions.
----
-
diff --git a/_posts/plotly_js/maps/outline-map-locations/2019-07-03-iso3-table.html b/_posts/plotly_js/maps/outline-map-locations/2019-07-03-iso3-table.html
index 3c5f16104..4e93a8525 100644
--- a/_posts/plotly_js/maps/outline-map-locations/2019-07-03-iso3-table.html
+++ b/_posts/plotly_js/maps/outline-map-locations/2019-07-03-iso3-table.html
@@ -8,6 +8,15 @@
markdown_content: |
The following ISO codes are supported when `locationmode='ISO-3'`:
+ Codes marked † are only present in the higher-resolution map data. Since
+ [`geo.resolution`](https://plotly.com/javascript/reference/layout/geo/#layout-geo-resolution) defaults to `110`,
+ plotting one of those locations also needs `resolution: 50` on the `geo` subplot, or the location is skipped and
+ nothing is drawn for it.
+
+ Rows marked *(grouped with ...)* are territories the map data draws inside another country's feature, listed here
+ so the code is easy to find. Plotting one shades that whole country, and the territory name itself is not accepted
+ as a value for `locationmode: 'country names'`.
+
@@ -21,38 +30,38 @@
Åland Islands
ALA
Albania
ALB
Algeria
DZA
-
American Samoa
ASM
-
Andorra
AND
+
American Samoa
ASM †
+
Andorra
AND †
Angola
AGO
-
Anguilla
AIA
+
Anguilla
AIA †
Antarctica
ATA
-
Antigua and Barbuda
ATG
+
Antigua and Barbuda
ATG †
Argentina
ARG
Armenia
ARM
-
Aruba
ABW
+
Aruba
ABW †
Arunachal Pradesh
XAP
Australia
AUS
Austria
AUT
Azerbaijan
AZE
-
Azores Islands
PRT
+
Azores Islands (grouped with Portugal)
PRT
Bahamas
BHS
-
Bahrain
BHR
+
Bahrain
BHR †
Bangladesh
BGD
-
Barbados
BRB
+
Barbados
BRB †
Belarus
BLR
Belgium
BEL
Belize
BLZ
Benin
BEN
-
Bermuda
BMU
+
Bermuda
BMU †
Bhutan
BTN
Bir Tawil
XBT
Bolivia (Plurinational State of)
BOL
-
Bonaire
BES
+
Bonaire
BES †
Bosnia and Herzegovina
BIH
Botswana
BWA
-
Bouvet Island
BVT
+
Bouvet Island
BVT †
Brazil
BRA
-
British Virgin Islands
VGB
+
British Virgin Islands
VGB †
Brunei Darussalam
BRN
Bulgaria
BGR
Burkina Faso
BFA
@@ -61,24 +70,24 @@
Cambodia
KHM
Cameroon
CMR
Canada
CAN
-
Canary Islands
ESP
-
Cayman Islands
CYM
+
Canary Islands (grouped with Spain)
ESP
+
Cayman Islands
CYM †
Central African Republic
CAF
Chad
TCD
-
Chagos Archipelago
MUS
+
Chagos Archipelago (grouped with Mauritius)
MUS
Chile
CHL
China
CHN
-
Christmas Island
CXR
-
Cocos (Keeling) Islands
CCK
+
Christmas Island
CXR †
+
Cocos (Keeling) Islands
CCK †
Colombia
COL
Comoros
COM
Congo
COG
-
Cook Islands
COK
+
Cook Islands
COK †
Costa Rica
CRI
Côte d'Ivoire
CIV
Croatia
HRV
Cuba
CUB
-
Curaçao
CUW
+
Curaçao
CUW †
Cyprus
CYP
Czechia
CZE
Democratic People's Republic of Korea
PRK
@@ -96,7 +105,7 @@
Eswatini
SWZ
Ethiopia
ETH
Falkland Islands (Malvinas)
FLK
-
Faroe Islands
FRO
+
Faroe Islands
FRO †
Fiji
FJI
Finland
FIN
France
FRA
@@ -104,28 +113,28 @@
French Polynesia
PYF
French Southern Territories
ATF
Gabon
GAB
-
Galápagos Islands
ECU
+
Galápagos Islands (grouped with Ecuador)
ECU
Gambia
GMB
-
Gaza
PSE
+
Gaza (grouped with State of Palestine)
PSE
Georgia
GEO
Germany
DEU
Ghana
GHA
-
Gibraltar
GIB
+
Gibraltar
GIB †
Greece
GRC
Greenland
GRL
-
Grenada
GRD
+
Grenada
GRD †
Guadeloupe
GLP
Guam
GUM
Guatemala
GTM
-
Guernsey
GGY
+
Guernsey
GGY †
Guinea
GIN
Guinea-Bissau
GNB
Guyana
GUY
Haiti
HTI
Halaib Triangle
XHT
-
Heard Island and McDonald Islands
HMD
+
Heard Island and McDonald Islands
HMD †
Honduras
HND
-
Hong Kong
HKG
+
Hong Kong
HKG †
Hungary
HUN
Iceland
ISL
Ilemi Triangle
XIT
@@ -134,18 +143,18 @@
Iran (Islamic Republic of)
IRN
Iraq
IRQ
Ireland
IRL
-
Isle of Man
IMN
+
Isle of Man
IMN †
Israel
ISR
Italy
ITA
Jamaica
JAM
Jammu and Kashmir
XJK
Japan
JPN
-
Jersey
JEY
+
Jersey
JEY †
Jordan
JOR
Kazakhstan
KAZ
Kenya
KEN
Kingdom of the Netherlands
NLD
-
Kiribati
KIR
+
Kiribati
KIR †
Kuwait
KWT
Kyrgyzstan
KGZ
Lao People's Democratic Republic
LAO
@@ -154,53 +163,53 @@
Lesotho
LSO
Liberia
LBR
Libya
LBY
-
Liechtenstein
LIE
+
Liechtenstein
LIE †
Lithuania
LTU
Luxembourg
LUX
-
Macao
MAC
+
Macao
MAC †
Madagascar
MDG
-
Madeira Island
PRT
+
Madeira Island (grouped with Portugal)
PRT
Malawi
MWI
Malaysia
MYS
-
Maldives
MDV
+
Maldives
MDV †
Mali
MLI
-
Malta
MLT
-
Marshall Islands
MHL
+
Malta
MLT †
+
Marshall Islands
MHL †
Martinique
MTQ
Mauritania
MRT
Mauritius
MUS
-
Mayotte
MYT
+
Mayotte
MYT †
Mexico
MEX
-
Micronesia (Federated States of)
FSM
-
Monaco
MCO
+
Micronesia (Federated States of)
FSM †
+
Monaco
MCO †
Mongolia
MNG
Montenegro
MNE
-
Montserrat
MSR
+
Montserrat
MSR †
Morocco
MAR
Mozambique
MOZ
Myanmar
MMR
Namibia
NAM
-
Nauru
NRU
+
Nauru
NRU †
Nepal
NPL
New Caledonia
NCL
New Zealand
NZL
Nicaragua
NIC
Niger
NER
Nigeria
NGA
-
Niue
NIU
-
Norfolk Island
NFK
+
Niue
NIU †
+
Norfolk Island
NFK †
North Macedonia
MKD
-
Northern Mariana Islands
MNP
+
Northern Mariana Islands
MNP †
Norway
NOR
Oman
OMN
Pakistan
PAK
-
Palau
PLW
+
Palau
PLW †
Panama
PAN
Papua New Guinea
PNG
Paraguay
PRY
Peru
PER
Philippines
PHL
-
Pitcairn
PCN
+
Pitcairn
PCN †
Poland
POL
Portugal
PRT
Puerto Rico
PRI
@@ -211,24 +220,24 @@
Romania
ROU
Russian Federation
RUS
Rwanda
RWA
-
Saba
BES
-
Saint Barthélemy
BLM
-
Saint Helena
SHN
-
Saint Kitts and Nevis
KNA
-
Saint Lucia
LCA
-
Saint Martin
MAF
-
Saint Pierre and Miquelon
SPM
-
Saint Vincent and the Grenadines
VCT
+
Saba
BES †
+
Saint Barthélemy
BLM †
+
Saint Helena
SHN †
+
Saint Kitts and Nevis
KNA †
+
Saint Lucia
LCA †
+
Saint Martin
MAF †
+
Saint Pierre and Miquelon
SPM †
+
Saint Vincent and the Grenadines
VCT †
Samoa
WSM
Sao Tome and Principe
STP
Saudi Arabia
SAU
Senegal
SEN
Serbia
SRB
-
Seychelles
SYC
+
Seychelles
SYC †
Sierra Leone
SLE
-
Singapore
SGP
-
Sint Eustatius
BES
-
Sint Maarten
SXM
+
Singapore
SGP †
+
Sint Eustatius
BES †
+
Sint Maarten
SXM †
Slovakia
SVK
Slovenia
SVN
Solomon Islands
SLB
@@ -249,27 +258,27 @@
Thailand
THA
Timor-Leste
TLS
Togo
TGO
-
Tokelau
TKL
-
Tonga
TON
+
Tokelau
TKL †
+
Tonga
TON †
Trinidad and Tobago
TTO
Tunisia
TUN
Türkiye
TUR
Turkmenistan
TKM
-
Turks and Caicos Islands
TCA
-
Tuvalu
TUV
+
Turks and Caicos Islands
TCA †
+
Tuvalu
TUV †
Uganda
UGA
Ukraine
UKR
United Arab Emirates
ARE
United Kingdom of Great Britain and Northern Ireland
GBR
United Republic of Tanzania
TZA
United States of America
USA
-
United States Virgin Islands
VIR
+
United States Virgin Islands
VIR †
Uruguay
URY
Uzbekistan
UZB
Vanuatu
VUT
Venezuela (Bolivarian Republic of)
VEN
Viet Nam
VNM
-
West Bank
PSE
+
West Bank (grouped with State of Palestine)
PSE
Western Sahara
ESH
Yemen
YEM
Zambia
ZMB
@@ -279,4 +288,3 @@
[View full list of ISO-3 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
---
-
diff --git a/_posts/plotly_js/maps/scatter-plot-on-maps/2015-07-11-scatter_maps_plotly_js_index.html b/_posts/plotly_js/maps/scatter-plot-on-maps/2015-07-11-scatter_maps_plotly_js_index.html
index a15592334..4447dfa7c 100755
--- a/_posts/plotly_js/maps/scatter-plot-on-maps/2015-07-11-scatter_maps_plotly_js_index.html
+++ b/_posts/plotly_js/maps/scatter-plot-on-maps/2015-07-11-scatter_maps_plotly_js_index.html
@@ -5,7 +5,7 @@
language: plotly_js
layout: base
name: Scatter Plots on Maps
-order: 7
+order: 6
permalink: javascript/scatter-plots-on-maps/
redirect_from: javascript-graphing-library/scatter-plots-on-maps/
thumbnail: thumbnail/scatter-plot-on-maps.jpg
diff --git a/_posts/plotly_js/maps/scatter-plot-on-maps/2015-08-12-US-airport-map.html b/_posts/plotly_js/maps/scatter-plot-on-maps/2015-08-12-US-airport-map.html
index 8eca7fd36..3b15fe899 100644
--- a/_posts/plotly_js/maps/scatter-plot-on-maps/2015-08-12-US-airport-map.html
+++ b/_posts/plotly_js/maps/scatter-plot-on-maps/2015-08-12-US-airport-map.html
@@ -59,6 +59,6 @@
}
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/scatter-plot-on-maps/2015-08-15-north-america-percipitation-map.html b/_posts/plotly_js/maps/scatter-plot-on-maps/2015-08-15-north-america-precipitation-map.html
similarity index 87%
rename from _posts/plotly_js/maps/scatter-plot-on-maps/2015-08-15-north-america-percipitation-map.html
rename to _posts/plotly_js/maps/scatter-plot-on-maps/2015-08-15-north-america-precipitation-map.html
index 72305d527..30db69748 100644
--- a/_posts/plotly_js/maps/scatter-plot-on-maps/2015-08-15-north-america-percipitation-map.html
+++ b/_posts/plotly_js/maps/scatter-plot-on-maps/2015-08-15-north-america-precipitation-map.html
@@ -46,6 +46,7 @@
var layout = {
geo:{
scope: 'north america',
+ fitbounds: false,
showland: true,
landcolor: 'rgb(212,212,212)',
subunitcolor: 'rgb(255,255,255)',
@@ -61,18 +62,18 @@
long: -100
}
},
- },
- longaxis: {
- showgrid: true,
- gridwidth: 0.5,
- range: [ -140.0, -55.0 ],
- dtick: 5
- },
- lataxis: {
- showgrid: true,
- gridwidth: 0.5,
- range: [ 20.0, 60.0 ],
- dtick: 5
+ lonaxis: {
+ showgrid: true,
+ gridwidth: 0.5,
+ range: [ -140.0, -55.0 ],
+ dtick: 5
+ },
+ lataxis: {
+ showgrid: true,
+ gridwidth: 0.5,
+ range: [ 20.0, 60.0 ],
+ dtick: 5
+ }
},
title: {text: 'North America Precipitation'},
width: 600,
diff --git a/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_basic-mapbox.html b/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_basic-mapbox.html
deleted file mode 100644
index b8c3d7243..000000000
--- a/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_basic-mapbox.html
+++ /dev/null
@@ -1,46 +0,0 @@
----
-name: Basic Example (Mapbox)
-language: plotly_js
-suite: scatter-tile-maps
-order: 10
-sitemap: false
-arrangement: horizontal
-markdown_content: |
-
- > Mapbox traces are deprecated and may be removed in a future version of Plotly.js.
-
- Earlier examples use traces that render with [Maplibre GL JS](https://maplibre.org/maplibre-gl-js/docs/).
- These traces were introduced in Plotly.js 2.35.0 and replace Mapbox-based tile maps,
- which are now deprecated. Here's one of the earlier examples using the Mapbox-based `choroplethmapbox` trace
----
-
-var data = [{
- type:'scattermapbox',
- lat:['45.5017'],
- lon:['-73.5673'],
- mode:'markers',
- marker: {
- size:14
- },
- text:['Montreal']
-}]
-
-var layout = {
- autosize: true,
- hovermode:'closest',
- mapbox: {
- bearing:0,
- center: {
- lat:45,
- lon:-73
- },
- pitch:0,
- zoom:5
- },
-}
-
-Plotly.setPlotConfig({
- mapboxAccessToken: "your access token"
-})
-
-Plotly.newPlot('myDiv', data, layout)
diff --git a/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_lines.html b/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_lines.html
index 8b4f827d9..1ca987c2b 100644
--- a/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_lines.html
+++ b/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_lines.html
@@ -66,6 +66,6 @@
showlegend: false
};
- Plotly.newPlot("myDiv", data, layout, {showLink: false});
+ Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_plotly_js_index.html b/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_plotly_js_index.html
index efef2c956..9df66d355 100755
--- a/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_plotly_js_index.html
+++ b/_posts/plotly_js/maps/scattermapbox/2017-08-01-scattermapbox_plotly_js_index.html
@@ -4,7 +4,7 @@
language: plotly_js
layout: base
name: Scatter Plots on Tile Maps
-order: 8
+order: 7
permalink: javascript/scatter-tile-maps/
redirect_from: javascript/scattermapbox/
thumbnail: thumbnail/scatter-mapbox.jpg
diff --git a/_posts/plotly_js/maps/scattermapbox/2019-09-02-symbols.html b/_posts/plotly_js/maps/scattermapbox/2019-09-02-symbols.html
index a66df21a8..dddc7149b 100644
--- a/_posts/plotly_js/maps/scattermapbox/2019-09-02-symbols.html
+++ b/_posts/plotly_js/maps/scattermapbox/2019-09-02-symbols.html
@@ -6,7 +6,9 @@
sitemap: false
arrangement: horizontal
markdown_content: |
- This example uses [symbol attribute](https://plotly.com/javascript/reference/scattermap/#scattermap-marker-symbol) to set the marker symbol.
+ This example uses the [symbol attribute](https://plotly.com/javascript/reference/scattermap/#scattermap-marker-symbol) to set the marker symbol.
+ Symbol names come from the [Maki icon set](https://labs.mapbox.com/maki-icons/) (updated to Maki 8 in Plotly.js v4).
+ Since v4, icons are tinted with `marker.color`; earlier versions always drew them in black.
---
var data = [
{
@@ -14,7 +16,7 @@
mode: "markers+text+lines",
lon: [-75, -80, -50],
lat: [45, 20, -20],
- marker: { size: 20, symbol: ["bus", "harbor", "airport"] },
+ marker: { size: 20, color: "black", symbol: ["bus", "harbor", "airport"] },
text: ["Bus", "Harbor", "Airport"],
textposition: "bottom right"
}
diff --git a/_posts/plotly_js/scientific/quiver/2026-08-04-basic-quiver.html b/_posts/plotly_js/scientific/quiver/2026-08-04-basic-quiver.html
new file mode 100644
index 000000000..e2b4d3d33
--- /dev/null
+++ b/_posts/plotly_js/scientific/quiver/2026-08-04-basic-quiver.html
@@ -0,0 +1,27 @@
+---
+name: Basic Quiver Plot
+language: plotly_js
+suite: quiver
+order: 1
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ Each arrow is anchored at an `(x, y)` position and points along the `(u, v)` vector given for that position.
+---
+var data = [{
+ type: 'quiver',
+ x: [0, 1, 2, 0, 1, 2],
+ y: [0, 0, 0, 1, 1, 1],
+ u: [1, 0.5, 0, 0.5, 0, -0.5],
+ v: [0, 0.5, 1, 0.5, 1, 0.5]
+}];
+
+var layout = {
+ title: {text: 'Basic Quiver Plot'},
+ xaxis: {title: {text: 'x'}},
+ yaxis: {title: {text: 'y'}},
+ width: 600,
+ height: 400
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-anchor-size.html b/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-anchor-size.html
new file mode 100644
index 000000000..6f3dd4946
--- /dev/null
+++ b/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-anchor-size.html
@@ -0,0 +1,47 @@
+---
+name: Arrow Anchor and Length
+language: plotly_js
+suite: quiver
+order: 2
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ This example plots the rotational field `(u, v) = (-y, x)` on a grid. `anchor: 'center'` centers each arrow on its
+ grid point instead of starting it there, and `sizeref` scales every arrow by the same factor. With the default
+ `sizemode: 'scaled'`, arrow lengths are normalized against the longest vector in the field, so the grid stays legible
+ however large the underlying values are.
+---
+var x = [];
+var y = [];
+var u = [];
+var v = [];
+
+for (var i = -2; i <= 2; i++) {
+ for (var j = -2; j <= 2; j++) {
+ x.push(i);
+ y.push(j);
+ u.push(-j);
+ v.push(i);
+ }
+}
+
+var data = [{
+ type: 'quiver',
+ x: x,
+ y: y,
+ u: u,
+ v: v,
+ anchor: 'center',
+ sizeref: 0.8,
+ marker: {color: '#636efa'}
+}];
+
+var layout = {
+ title: {text: 'Rotational Field, Arrows Centered on Each Point'},
+ xaxis: {title: {text: 'x'}},
+ yaxis: {title: {text: 'y'}, scaleanchor: 'x'},
+ width: 600,
+ height: 500
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-color.html b/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-color.html
new file mode 100644
index 000000000..f94bf288e
--- /dev/null
+++ b/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-color.html
@@ -0,0 +1,57 @@
+---
+name: Color Arrows by a Scalar Field
+language: plotly_js
+suite: quiver
+order: 3
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ Pass `marker.color` an array with one value per arrow, together with the usual colorscale attributes
+ (`marker.colorscale`, `marker.cmin`, `marker.cmax`, `marker.showscale`, `marker.colorbar`), to color each arrow by
+ that value. Here the arrows are colored by their own magnitude. If you enable a colorscale without supplying a
+ `marker.color` array, arrows are colored by vector magnitude automatically. A single (non-array) `marker.color`
+ paints the whole field one color.
+---
+var x = [];
+var y = [];
+var u = [];
+var v = [];
+var speed = [];
+
+// A shear flow: horizontal velocity grows with y, with a small vertical component.
+for (var i = 0; i <= 8; i++) {
+ for (var j = 0; j <= 6; j++) {
+ var ui = 0.2 + 0.25 * j;
+ var vi = 0.4 * Math.sin(i / 2);
+ x.push(i);
+ y.push(j);
+ u.push(ui);
+ v.push(vi);
+ speed.push(Math.sqrt(ui * ui + vi * vi));
+ }
+}
+
+var data = [{
+ type: 'quiver',
+ x: x,
+ y: y,
+ u: u,
+ v: v,
+ marker: {
+ color: speed,
+ colorscale: 'Viridis',
+ showscale: true,
+ colorbar: {title: {text: 'speed'}},
+ line: {width: 2}
+ }
+}];
+
+var layout = {
+ title: {text: 'Shear Flow, Arrows Colored by Speed'},
+ xaxis: {title: {text: 'x'}},
+ yaxis: {title: {text: 'y'}},
+ width: 700,
+ height: 500
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-style.html b/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-style.html
new file mode 100644
index 000000000..72ef32ab8
--- /dev/null
+++ b/_posts/plotly_js/scientific/quiver/2026-08-04-quiver-style.html
@@ -0,0 +1,66 @@
+---
+name: Style Arrow Lines and Heads
+language: plotly_js
+suite: quiver
+order: 4
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ `marker.line.width` and `marker.line.dash` style the arrow shafts, and `marker.arrowsize` scales the arrowhead
+ relative to the line width — the default of `1` draws a head about three times as wide as the shaft. This example
+ overlays a measured field (solid) on a modelled one (dashed) so the two can be compared arrow for arrow.
+---
+var x = [];
+var y = [];
+var uModel = [];
+var vModel = [];
+var uMeasured = [];
+var vMeasured = [];
+
+for (var i = 0; i <= 5; i++) {
+ for (var j = 0; j <= 5; j++) {
+ x.push(i);
+ y.push(j);
+ uModel.push(1);
+ vModel.push(0.15 * (j - 2.5));
+ uMeasured.push(0.9);
+ vMeasured.push(0.15 * (j - 2.5) + 0.25 * Math.cos(i));
+ }
+}
+
+var data = [{
+ type: 'quiver',
+ name: 'model',
+ x: x,
+ y: y,
+ u: uModel,
+ v: vModel,
+ marker: {
+ color: '#7f7f7f',
+ arrowsize: 0.8,
+ line: {width: 2, dash: 'dot'}
+ }
+}, {
+ type: 'quiver',
+ name: 'measured',
+ x: x,
+ y: y,
+ u: uMeasured,
+ v: vMeasured,
+ marker: {
+ color: '#d62728',
+ arrowsize: 1.2,
+ line: {width: 3}
+ }
+}];
+
+var layout = {
+ title: {text: 'Modelled and Measured Fields'},
+ xaxis: {title: {text: 'x'}},
+ yaxis: {title: {text: 'y'}},
+ showlegend: true,
+ width: 700,
+ height: 500
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/plotly_js/scientific/quiver/2026-08-04-quiver_plotly_js_index.html b/_posts/plotly_js/scientific/quiver/2026-08-04-quiver_plotly_js_index.html
new file mode 100644
index 000000000..ed77e328d
--- /dev/null
+++ b/_posts/plotly_js/scientific/quiver/2026-08-04-quiver_plotly_js_index.html
@@ -0,0 +1,37 @@
+---
+description: How to make a D3.js-based quiver plot in JavaScript. Quiver plots show a 2D vector field as an array of arrows.
+display_as: scientific
+language: plotly_js
+layout: base
+name: Quiver Plots
+order: 13
+page_type: example_index
+permalink: javascript/quiver-plots/
+thumbnail: thumbnail/quiver-plot.jpg
+---
+
+
The quiver trace type, new in Plotly.js v4, visualizes a 2D vector field as an array of arrows. A
+quiver trace takes four arrays of the same length: x and y give the position of each arrow,
+and u and v give the vector components at that position. Arrow direction and length come
+from (u, v).
+
+
Arrow placement and scaling are controlled by:
+
+
+
anchor — which part of the arrow sits at (x, y): 'tail' (the default),
+ 'tip', or 'center'.
+
sizemode — 'scaled' (the default) normalizes arrow lengths against the largest vector
+ and the density of points, so a dense field stays readable; 'raw' draws each arrow at its own
+ magnitude.
+
sizeref — a multiplier applied on top of sizemode. Values below 1 shorten every
+ arrow, values above 1 lengthen them.
+
anglemode — with 'data', angles are measured in data coordinates, so they change when
+ you zoom one axis more than the other; with 'paper', angles are fixed in pixel space.
+
+
+
Arrow lines are styled with marker.line.width and marker.line.dash, and the arrowhead is
+scaled relative to the line width by marker.arrowsize. Quiver traces also support box and lasso
+selection through the standard selected / unselected marker attributes.
+
+{% assign examples = site.posts | where:"language","plotly_js" | where:"suite","quiver" | sort: "order" %}
+{% include posts/auto_examples.html examples=examples %}
diff --git a/_posts/plotly_js/statistical/continuous-error-bars/2016-02-15-continuous-variable.html b/_posts/plotly_js/statistical/continuous-error-bars/2016-02-15-continuous-variable.html
index e8102ebca..e11b6b035 100644
--- a/_posts/plotly_js/statistical/continuous-error-bars/2016-02-15-continuous-variable.html
+++ b/_posts/plotly_js/statistical/continuous-error-bars/2016-02-15-continuous-variable.html
@@ -37,7 +37,7 @@
x: date_list(2001,01,01,2001,02,01,50),
y: random_number(50,20),
line: {width: 0},
- marker: {color: "444"},
+ marker: {color: "#444"},
mode: "lines",
name: "Lower Bound",
type: "scatter"
@@ -60,7 +60,7 @@
fill: "tonexty",
fillcolor: "rgba(68, 68, 68, 0.3)",
line: {width: 0},
- marker: {color: "444"},
+ marker: {color: "#444"},
mode: "lines",
name: "Upper Bound",
type: "scatter"
diff --git a/_posts/plotly_js/statistical/error-bar/2015-04-09-error-bar-style.html b/_posts/plotly_js/statistical/error-bar/2015-04-09-error-bar-style.html
index 0b76dfce6..55c14029d 100755
--- a/_posts/plotly_js/statistical/error-bar/2015-04-09-error-bar-style.html
+++ b/_posts/plotly_js/statistical/error-bar/2015-04-09-error-bar-style.html
@@ -46,4 +46,4 @@
type: 'scatter'
};
var data = [trace1, trace2];
-Plotly.newPlot('myDiv', data, {}, {showSendToCloud: true});
+Plotly.newPlot('myDiv', data, {});
diff --git a/_posts/plotly_js/subplot/mixed-subplots/2017-01-20-mixed-subplots.html b/_posts/plotly_js/subplot/mixed-subplots/2017-01-20-mixed-subplots.html
index 442b32f5e..3fc235bfd 100644
--- a/_posts/plotly_js/subplot/mixed-subplots/2017-01-20-mixed-subplots.html
+++ b/_posts/plotly_js/subplot/mixed-subplots/2017-01-20-mixed-subplots.html
@@ -85,6 +85,7 @@
y: [0.02, 0.98]
},
scope: 'world',
+ fitbounds: false,
projection: {
type: 'orthographic'
},
@@ -140,6 +141,6 @@
domain: [0.6, 1]},
};
-Plotly.newPlot("myDiv", data, layout, {showLink: false});
+Plotly.newPlot("myDiv", data, layout);
});
diff --git a/_posts/plotly_js/subplot/multiple-axes/2015-04-09-multiple-axes-double.html b/_posts/plotly_js/subplot/multiple-axes/2015-04-09-multiple-axes-double.html
index 8eed0bc93..f4a03159e 100755
--- a/_posts/plotly_js/subplot/multiple-axes/2015-04-09-multiple-axes-double.html
+++ b/_posts/plotly_js/subplot/multiple-axes/2015-04-09-multiple-axes-double.html
@@ -5,6 +5,10 @@
order: 5
sitemap: false
arrangement: horizontal
+markdown_content: |
+ Set `overlaying` on the second axis to draw both traces in the same plotting area. The overlaying axis places its
+ ticks at the base axis's tick positions, labeled with its own range — see
+ [Tick Positions on Overlaying Axes](#tick-positions-on-overlaying-axes) to give it an independent grid instead.
---
var trace1 = {
x: [1, 2, 3],
diff --git a/_posts/plotly_js/subplot/multiple-axes/2026-08-04-overlaying-axis-tickmode.html b/_posts/plotly_js/subplot/multiple-axes/2026-08-04-overlaying-axis-tickmode.html
new file mode 100644
index 000000000..6956acc75
--- /dev/null
+++ b/_posts/plotly_js/subplot/multiple-axes/2026-08-04-overlaying-axis-tickmode.html
@@ -0,0 +1,53 @@
+---
+name: Tick Positions on Overlaying Axes
+language: plotly_js
+suite: multiple-axes
+order: 7
+sitemap: false
+arrangement: horizontal
+markdown_content: |
+ An axis that overlays another axis defaults to [tickmode](https://plotly.com/javascript/reference/layout/yaxis/#layout-yaxis-tickmode)
+ `'sync'`: it draws its ticks and gridlines at the base axis's positions and computes the labels from its own range, so
+ the two axes share one grid. Set `tickmode: 'auto'` on the overlaying axis to let it choose its own tick positions
+ instead, which draws a second, independent set of gridlines.
+
+ Prior to Plotly.js v4, `'auto'` was the default on overlaying axes. When the base axis is `type: 'category'` or
+ `'multicategory'`, `'auto'` is still the default.
+---
+var trace1 = {
+ x: [1, 2, 3],
+ y: [40, 50, 60],
+ name: 'yaxis data',
+ type: 'scatter'
+};
+
+var trace2 = {
+ x: [2, 3, 4],
+ y: [4, 5, 6],
+ name: 'yaxis2 data',
+ yaxis: 'y2',
+ type: 'scatter'
+};
+
+var data = [trace1, trace2];
+
+var layout = {
+ title: {text: 'Independent Ticks on an Overlaying Axis'},
+ yaxis: {
+ title: {
+ text: 'yaxis title'
+ }
+ },
+ yaxis2: {
+ title: {
+ text: 'yaxis2 title',
+ font: {color: 'rgb(148, 103, 189)'}
+ },
+ tickfont: {color: 'rgb(148, 103, 189)'},
+ overlaying: 'y',
+ side: 'right',
+ tickmode: 'auto'
+ }
+};
+
+Plotly.newPlot('myDiv', data, layout);
diff --git a/_posts/reference_pages/javascript/2020-07-20-choroplethmapbox.html b/_posts/reference_pages/javascript/2020-07-20-choroplethmapbox.html
index f6d7694e4..fa235a4f5 100644
--- a/_posts/reference_pages/javascript/2020-07-20-choroplethmapbox.html
+++ b/_posts/reference_pages/javascript/2020-07-20-choroplethmapbox.html
@@ -1,18 +1,4 @@
---
permalink: /javascript/reference/choroplethmapbox/
-layout: langindex
-page_type: reference
-language: plotly_js
-name: choroplethmapbox Traces
-description: Figure attribute reference for Plotly's JavaScript open-source graphing library.
+redirect_to: /javascript/reference/choroplethmap/
---
-
-