Merge pull request #401 from plotly/update-docs

update docs for v6.5 v3.3

Author: LiamConnors

_data/jsversion.json

@@ -1,3 +1,3 @@
 {
-  "version": "3.2.0"
+  "version": "3.3.0"
 }

_data/plotschema.json

@@ -43478,6 +43478,26 @@
           "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 `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.",
+          "dflt": "",
+          "editType": "none",
+          "valType": "string",
+          "magic_underscores": "fig.update_traces(hovertemplate=&lt;VALUE&gt;, selector=dict(type='ohlc'))"
+        },
+        "hovertemplatesrc": {
+          "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+          "editType": "none",
+          "valType": "string"
+        },
+        "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=&lt;VALUE&gt;, selector=dict(type='ohlc'))"
+        },
         "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": "",
@@ -43888,7 +43908,7 @@
             "magic_underscores": "fig.update_traces(hoverlabel_showarrow=&lt;VALUE&gt;, selector=dict(type='ohlc'))"
           },
           "split": {
-            "description": "Show hover information (open, close, high, low) in separate labels.",
+            "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",
@@ -44277,6 +44297,26 @@
           "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 `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.",
+          "dflt": "",
+          "editType": "none",
+          "valType": "string",
+          "magic_underscores": "fig.update_traces(hovertemplate=&lt;VALUE&gt;, selector=dict(type='candlestick'))"
+        },
+        "hovertemplatesrc": {
+          "description": "Sets the source reference on Chart Studio Cloud for `hovertemplate`.",
+          "editType": "none",
+          "valType": "string"
+        },
+        "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=&lt;VALUE&gt;, selector=dict(type='candlestick'))"
+        },
         "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": "",
@@ -44663,7 +44703,7 @@
             "magic_underscores": "fig.update_traces(hoverlabel_showarrow=&lt;VALUE&gt;, selector=dict(type='candlestick'))"
           },
           "split": {
-            "description": "Show hover information (open, close, high, low) in separate labels.",
+            "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",

_data/pyversion.json

@@ -1,3 +1,3 @@
 {
-  "version": "6.4.0"
+  "version": "6.5.0"
 }