@arcgis/charts-components 5.0.0-next.9 → 5.0.0-next.91

package/dist/docs/vscode.html-custom-data.json

@@ -4,11 +4,11 @@
   "tags": [
     {
       "name": "arcgis-chart",
-      "description": "The ArcGIS Chart component renders various chart types based on the provided model.\n\nSupported chart types include bar charts, line charts, pie charts, box plots, combo bar-line charts, gauges, scatterplots, histograms and radar charts.\n\nThe Chart component can be rendered using an [existing model](https://developers.arcgis.com/javascript/latest/charts-components-intro/#use-an-existing-model-from-a-webmap-or-feature-layer) from a web map or feature layer,\nor by [creating a new model](https://developers.arcgis.com/javascript/latest/charts-components-intro/#create-a-new-model).\n\nSee also:\n- [Introduction to Charts components](https://developers.arcgis.com/javascript/latest/charts-components-intro/)\n- [Tutorial: Display and create charts components](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)\n--\n\n### Events\n- **arcgisAxesMinMaxChange** - Event triggered once the chart axes min/max values are computed\n- **arcgisBadDataWarningRaise** - Event triggered when an error is detected with the data set\n- **arcgisChartNotFoundWarning** - Event triggered when the chart is not found for the given `chartIndex` property.\n- **arcgisConfigChange** - Event triggered when the chart config is changed\n- **arcgisDataFetchComplete** - Event triggered once the chart data has been fetched but not yet fully processed.\nFor instance it can be useful for a pie chart to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n- **arcgisDataProcessComplete** - Event triggered once the chart data has been processed\n- **arcgisDataProcessError** - Event triggered when an error occurred while fetching of processing the data for the chart\n- **arcgisLegendItemVisibilityChange** - Event triggered once a legend item visibility has been changed\n- **arcgisNoRenderPropChange** - Event triggered when a no-render prop is changed\n- **arcgisRuntimeError** - Event triggered when an error occurred that prevents the chart from being created or updated\n- **arcgisSelectionComplete** - Event triggered when a selection is applied to the chart\n- **arcgisSeriesColorChange** - Event triggered once the chart series color have been assigned\n- **arcgisSeriesOrder** - Event carrying the series id as they have been sorted following the `orderOptions` instructions\n- **arcgisUpdateComplete** - Event triggered once the chart is updated\n\n### Methods\n- `clearSelection(): Promise<void>` - Clears all selection on the chart.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `errorAlert(errorMessage?: string): Promise<void>` - Triggers an alert to display an error message.\n- `exportAsCSV(options?: CSVOptions): Promise<void>` - Export the current chart's data as a CSV file.\n- `exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>` - Export the current chart as an image.\n- `loadModel(): Promise<void>` - Returns a promise that resolves when the chart model is fully loaded.\n- `notify(message?: string, heading?: string, options?: NotifyOptions): Promise<void>` - Notify method allows passing external messages to the chart component.\nIt can be used to pass validation or information messages.\nIn a situation where a config update is overriding your notification modal,\nconsider waiting for the `arcgisUpdateComplete` event.\n- `refresh(props?: { updateData?: boolean; resetAxesBounds?: boolean; updateExtent?: boolean; }): Promise<void>` - Re-render the chart.\n- `resetZoom(): Promise<void>` - Resets the chart zoom to bring it back to full extent\n- `switchSelection(): Promise<void>` - Switches the selection on the chart.\n\n### Slots\n- **action-bar** - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.",
+      "description": "The Chart component renders a chart based on the provided model. Get started by reading the [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) page.\n\nSupported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.\n--\n\n### Events\n- **arcgisAxesMinMaxChange** - Event triggered once the chart axes min/max values are computed.\n- **arcgisBadDataWarningRaise** - Event triggered when an error is detected with the data set.\n- **arcgisChartNotFoundWarning** - Event triggered when the chart is not found for the given `chartIndex` property.\n- **arcgisConfigChange** - Event triggered when the chart config is changed.\n- **arcgisDataFetchComplete** - Event triggered once the chart data has been fetched but not yet fully processed.\n\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n\n**Note**: Applicable to pie chart only.\n- **arcgisDataProcessComplete** - Event triggered once the chart data has been processed.\n- **arcgisDataProcessError** - Event triggered when an error occurred while fetching of processing the data for the chart.\n- **arcgisLegendItemVisibilityChange** - Event triggered once a legend item visibility has been changed.\n- **arcgisNoRenderPropChange** - Event triggered when a no-render prop is changed.\n- **arcgisRenderingComplete** - Event triggered once the chart rendering is complete.\n- **arcgisRuntimeError** - Event triggered when an error occurred that prevents the chart from being created or updated.\n- **arcgisSelectionComplete** - Event triggered when a selection is applied to the chart.\n- **arcgisSeriesColorChange** - Event triggered once the chart series color have been assigned.\n- **arcgisSeriesOrder** - Event carrying the series id as they have been sorted following the `orderOptions` instructions.\n- **arcgisUpdateComplete** - Event triggered once the chart is updated.\n\n### Methods\n- `clearSelection(): Promise<void>` - Clears all selection on the chart.\n\n**Note**: Not applicable to gauge.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `errorAlert(errorMessage?: string): Promise<void>` - Triggers an alert to display an error message.\n- `exportAsCSV(options?: CSVOptions): Promise<void>` - Export the current chart's data as a CSV file.\n\nThe `Options` object can contain the following properties:\n- `columns`: An array of column to include in the CSV file.\n- `delimiter`: The delimiter to use in the CSV file. Default is `,`.\n- `includeHeader`: Whether to include the header row in the CSV file. Default is `true`.\n- `quoteAll`: Whether to quote all values in the CSV file. Default is `false`.\n- `locale`: The locale to use when formatting the CSV file. Default is `en`.\n   - Locale supported are: \"ar\", \"ar-u-nu-latn\", \"bs\", \"bg\", \"ca\", \"cs\", \"da\", \"de\", \"el\", \"en\", \"en-US\", \"es\", \"et\", \"fi\", \"fr\", \"he\", \"hr\", \"hu\", \"id\", \"it\", \"ja\", \"ko\", \"lt\", \"lv\", \"no\", \"nl\", \"pl\", \"pt-BR\", \"pt-PT\", \"ro\", \"ru\", \"sr\", \"sl\", \"sk\", \"sv\", \"th\", \"tr\", \"uk\", \"vi\", \"zh-CN\", \"zh-HK\", \"zh-TW\"\n\n**Note**: The chart types supported by this method are:\n- Bar chart\n- Box plot\n- Combo bar and line chart\n- Histogram\n- Line chart\n- Pie chart\n- `exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>` - Exports the current chart as an image. The default format is PNG, with SVG and JPEG available as alternatives.\n- `loadModel(): Promise<void>` - Returns a promise that resolves when the chart model is fully loaded.\n- `notify(message?: string, heading?: string, options?: NotifyOptions): Promise<void>` - Notify method allows passing external messages to the chart component.\nIt can be used to pass validation or information messages.\nIn a situation where a config update is overriding your notification modal, consider waiting for the `arcgisUpdateComplete` event.\n- `refresh(props?: { updateData?: boolean; resetAxesBounds?: boolean; }): Promise<void>` - Re-render the chart.\n- `resetZoom(): Promise<void>` - Resets the chart zoom to bring it back to full extent\n\n**Note**: Applicable to XY charts only.\n- `switchSelection(): Promise<void>` - Switches the selection on the chart.\n\n**Note**: Not applicable to gauge.\n\n### Slots\n- **action-bar** - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.",
       "attributes": [
         {
           "name": "action-mode",
-          "description": "Not applicable to gauge.\nDefines the cursor behavior on the chart (zoom, selection...).",
+          "description": "Specifies the user action behavior for the chart.\n\n- `monoSelection`: Select a single data point or series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points or series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points or series while holding the Ctrl key (Cmd on Mac). When the key is held, each new selection is added; otherwise, the selection is replaced.\n- `none`: No action is performed on user interaction.\n- `zoom`: Zoom into a specific area of the chart.\n\n**Note**: Not applicable to gauge.",
           "values": [
             {
               "name": "monoSelection"
@@ -29,17 +29,22 @@
         },
         {
           "name": "allow-using-object-id-stat",
-          "description": "Whether to allow the object id to be used as a statistic other than COUNT.",
+          "description": "Whether to allow the object id to be used as a statistic other than `COUNT`.",
+          "values": []
+        },
+        {
+          "name": "auto-destroy-disabled",
+          "description": "If `true`, the chart will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the chart to a different place on the page, or temporarily hide it.",
           "values": []
         },
         {
           "name": "auto-dispose-chart",
-          "description": "Auto-disposes the chart when a new one is created in the same container.",
+          "description": "**Deprecated**: since 5.0. Use [autoDestroyDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/#autoDestroyDisabled) instead.. Auto disposes the chart when a new one is created in the same container.",
           "values": []
         },
         {
           "name": "auto-inverse-data-label-text-color",
-          "description": "When `true`, the data label text color is automatically inverted based on the data label background color.\nFor example if the data label is dark, and it's on top of a dark color series area, the text color will eventually\nbe set to either the chart's background color or white.",
+          "description": "When `true`, the data label text color is automatically adjusted for readability based on its background.\nIf the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.",
           "values": []
         },
         {
@@ -49,7 +54,7 @@
         },
         {
           "name": "cursor-range",
-          "description": "Sets the cursor range:\n- CursorRange.MultiAxes: allows to draw a free rectangle\n- CursorRange.XAxis: allows to draw a rectangle bound to the x-axis\n- CursorRange.YAxis: allows to draw a rectangle bound to the y-axis\n- undefined: defaults to a preset behavior according to the chart type and action mode",
+          "description": "Sets the cursor range when `actionMode` is set to `zoom`, `multiSelection` or `multiSelectionWithCtrlKey`.\n\n- `multi-axes`: Allows to draw a free rectangle.\n- `x-axis`: Allows to draw a rectangle bound to the x-axis.\n- `y-axis`: Allows to draw a rectangle bound to the y-axis.\n- `undefined`: Defaults to the preset behavior according to the chart type and action mode.\n\n**Note**: Not applicable to gauge.",
           "values": [
             {
               "name": "multi-axes"
@@ -69,7 +74,12 @@
         },
         {
           "name": "disable-toggling-legend-items",
-          "description": "Disables the toggling of series via the legend items.",
+          "description": "Disables the toggling of series via the legend items.\n\n**Note**: Only applicable to multi-series charts.",
+          "values": []
+        },
+        {
+          "name": "enable-beta-features",
+          "description": "Whether to enable the beta features from the chart component.",
           "values": []
         },
         {
@@ -96,22 +106,22 @@
         },
         {
           "name": "feature-index",
-          "description": "The index of the feature to be rendered.\nOnly used when the gauge is a feature-based gauge.",
+          "description": "**Deprecated**: since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead.. The index of the feature to render when using a feature based gauge.\n\n**Note**: Only applicable to gauge.",
           "values": []
         },
         {
           "name": "filter-by-extent",
-          "description": "When `true`, all chart elements are filtered based on view extent.",
+          "description": "When `true`, all chart elements are filtered based on the view extent.",
           "values": []
         },
         {
           "name": "filter-by-selection",
-          "description": "When `true`, all chart elements are filtered based on selection.",
+          "description": "When `true`, all chart elements are filtered based on the selection.\n\n**Note**: Not applicable to gauge.",
           "values": []
         },
         {
           "name": "hide-empty-series",
-          "description": "When `true`, the empty series are completely hidden from the chart and the legend.\nFor example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by extent).",
+          "description": "When `true`, the empty series are completely hidden from the chart and the legend.\nFor example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by extent).\n\n**Note**: Not applicable to gauge.",
           "values": []
         },
         {
@@ -126,17 +136,17 @@
         },
         {
           "name": "ignore-smooth-rendering-limit",
-          "description": "When `true`, disables the default setting that uses debounce functions to handle the visibility of markers\nthat are outside of the plotting area when the min/max bound changes and/or when a zoom action is performed\n(via chart cursor or scrollbar), to increase performance.\nThis property will be set when the chart is created and cannot be updated after that.\nIt's recommended that this property should only be set to true for small datasets.\nWhen left `undefined`, will be treated as `false`.",
+          "description": "When `true`, disables the default setting that uses debounce functions to handle the visibility of markers\nthat are outside of the plotting area when the min/max bound changes and/or when a zoom action is performed\n(via chart cursor or scrollbar), to increase performance.\n\nThis property will be set when the chart is created and cannot be updated after that.\nIt's recommended that this property should only be set to `true` for small datasets.\nWhen left `undefined`, will be treated as `false`.\n\n**Note**: Applicable to line chart only.",
           "values": []
         },
         {
           "name": "ignore-view-extent",
-          "description": "This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.\nBy default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any\ngeometry passed through the config (component.config.dataFilters) or the runtime filters (component.runtimeDataFilters).\nSetting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.",
+          "description": "This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.\n\nBy default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any\ngeometry passed through the config (`component.config.dataFilters`) or the runtime filters (`component.runtimeDataFilters`).\n\nSetting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.",
           "values": []
         },
         {
           "name": "layer-fields-change-policy",
-          "description": "Allows the chart to update automatically when the layer's fields change.\nApplies when the field list (`fields`) in the feature layer is updated.",
+          "description": "Allows the chart to update automatically when the layer's fields change.\n\nApplies when the field list (`fields`) in the feature layer is updated.",
           "values": [
             {
               "name": "ignore"
@@ -165,7 +175,7 @@
         },
         {
           "name": "layer-renderer-change-policy",
-          "description": "Allows the chart to update automatically when the layer's renderer changes.\nApplies when the color match feature is enabled.",
+          "description": "Allows the chart to update automatically when the layer's renderer changes.\nApplies when the color match feature is enabled.\n\n**Note**: If the property is set to `ignore` the chart will use the layer's renderer information when the data is updated.",
           "values": [
             {
               "name": "ignore"
@@ -177,7 +187,7 @@
         },
         {
           "name": "legend-position",
-          "description": "Used to set the legend's position on the chart.",
+          "description": "**Deprecated**: since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead.. Sets the legend's position on the chart.\n\n**Note**: Not applicable to gauge.",
           "values": [
             {
               "name": "bottom"
@@ -195,12 +205,12 @@
         },
         {
           "name": "legend-visibility",
-          "description": "When `true`, the legend is visible on the chart.",
+          "description": "**Deprecated**: since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead.. When `true`, the legend is visible on the chart.\n\n**Note**: Not applicable to gauge.",
           "values": []
         },
         {
           "name": "null-as-valid",
-          "description": "Whether to consider a `null` statistic as valid. If set to `false` and the data has only\nnull values, the chart's dataset will be considered empty:\n- the corresponding warning event will be sent\n- the \"no data\" message will be displayed (unless `showUIMesssages` is set to `false`)",
+          "description": "Whether to consider a `null` statistic as valid. If set to `false` and the data has only null values, the chart's dataset will be considered empty:\n- The corresponding warning event will be sent\n- The \"no data\" message will be displayed (unless `showUIMesssages` is set to `false`)",
           "values": []
         },
         {
@@ -220,32 +230,32 @@
         },
         {
           "name": "return-features-extent",
-          "description": "When `true`, the features extent will be returned through the `arcgisDataProcessComplete` and `arcgisSelectionComplete` events payload.\nApplies only to:\n- charts using an aggregation\n- data source using a feature layer compatible with envelope aggregation\nThe extent (IExtent) is returned through a property called `arcgis_charts_features_extent`.",
+          "description": "When `true`, the features extent will be returned through the `arcgisDataProcessComplete` and `arcgisSelectionComplete` events payload.\nApplies only to:\n- Charts using an aggregation\n- Data source using a feature layer compatible with envelope aggregation\n\nThe extent (IExtent) is returned through a property called `arcgis_charts_features_extent`.\n\n**Note**: Not applicable to gauge.",
           "values": []
         },
         {
           "name": "return-selection-indexes",
-          "description": "When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.",
+          "description": "When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.\n\n**Note**: Not applicable to gauge.",
           "values": []
         },
         {
           "name": "return-selection-oi-ds",
-          "description": "When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.\nOnly considered for a data source using a feature layer.",
+          "description": "When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.\nOnly considered for a data source using a feature layer.\n\n**Note**: Not applicable to gauge.",
           "values": []
         },
         {
           "name": "rotation",
-          "description": "Applicable to bar chart, line chart, combo bar-line and box plot.\nWhen `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.",
+          "description": "**Deprecated**: since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#rotatedstate) prop instead.. When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar and line chart and box plot.",
           "values": []
         },
         {
           "name": "set-time-binning-info-when-not-provided",
-          "description": "When `true`, the series properties `unit` and `size` become optional and will be automatically set to values that fit the data set. Used when creating or updating a chart compatible with time binning.",
+          "description": "When `true`, the series properties `unit` and `size` become optional and will be automatically set to values that fit the data set. Used when creating or updating a chart compatible with time binning.\n\n**Note**: Only applicable to charts using the temporal binning feature (bar chart, line chart, combo bar and line chart, radar chart).",
           "values": []
         },
         {
           "name": "show-ui-messages",
-          "description": "Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an\naxis when the data contains values <= 0).",
+          "description": "Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an axis when the data contains values <= 0).",
           "values": []
         },
         {
@@ -282,7 +292,7 @@
         },
         {
           "name": "view-time-extent-change-policy",
-          "description": "Whether the chart should be refreshed when the view's time extent changes.\nThis is not currently supported on histogram. Setting the property to \"refresh\" won't have any effect on that chart.",
+          "description": "Whether the chart should be refreshed when the view's time extent changes.\n\n**Note**: Not supported for histogram.",
           "values": [
             {
               "name": "ignore"
@@ -318,6 +328,10 @@
           "name": "Gauge\nGauges visualize a single metric within a quantitative context defined by minimum and maximum values.",
           "url": "https://developers.arcgis.com/javascript/latest/storybook/charts-components/?path=/story/arcgis-chart--gauge&singleStory=true"
         },
+        {
+          "name": "Heat Chart\nHeat charts visualize data density or intensity across two dimensions, using color gradients to represent values.",
+          "url": "https://developers.arcgis.com/javascript/latest/storybook/charts-components/?path=/story/arcgis-chart--heat-chart&singleStory=true"
+        },
         {
           "name": "Histogram\nHistograms visualize the distribution of a continuous numeric variable by showing the frequency of values within defined intervals.",
           "url": "https://developers.arcgis.com/javascript/latest/storybook/charts-components/?path=/story/arcgis-chart--histogram&singleStory=true"
@@ -338,11 +352,11 @@
     },
     {
       "name": "arcgis-charts-action-bar",
-      "description": "The ArcGIS charts action bar component enhances chart functionality by offering context-specific actions such as rotation, zooming, and filtering.\nIt also supports general actions like exporting the chart as an image or CSV.\nThis component is designed to be used with a chart component and is not intended for standalone use.\n\nSee also:\n- [Tutorial: Charts components with Map components using charts action bar](https://developers.arcgis.com/javascript/latest/tutorials/charts-components-with-map-components/)\n--\n\n### Events\n- **arcgisActionBarToggle** - Event triggered once action bar expand is toggled\n- **arcgisDefaultActionSelect** - Event triggered once a default action is selected\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n\n### Slots\n- **custom-action-top** - A slot for adding custom `calcite-action` to the top of the default actions.\n- **custom-action-below** - A slot for adding custom `calcite-action` to the bottom of the default actions.",
+      "description": "The Charts Action Bar component provides context-specific actions such as rotation, zooming, and filtering, as well as general actions like exporting the chart as an image or CSV file.\nThis component is designed to be used with a chart component and is not intended for standalone use.\n--\n\n### Events\n- **arcgisActionBarToggle** - Event triggered once action bar expand is toggled.\n- **arcgisDefaultActionSelect** - Event triggered once a default action is selected.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n\n### Slots\n- **custom-action-top** - A slot for adding custom `calcite-action` to the top of the default actions.\n- **custom-action-below** - A slot for adding custom `calcite-action` to the bottom of the default actions.",
       "attributes": [
         {
           "name": "action-bar-selection-mode",
-          "description": "Action bar selection mode. Defines which selection mode the slotted action bar should use.",
+          "description": "Defines which selection mode the slotted action bar should use.\n- `monoSelection`: Select a single data point/series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points/series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points/series while holding the Ctrl key (Cmd key on Mac), new selection adds to the previous one.",
           "values": [
             {
               "name": "monoSelection"
@@ -393,7 +407,7 @@
         },
         {
           "name": "clear-selection-state",
-          "description": "When disabled, interaction with the clear selection action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the clear selection action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -410,7 +424,7 @@
         },
         {
           "name": "clear-selection-toggle",
-          "description": "When active, the clear selection action is highlighted.",
+          "description": "When `active`, the clear selection action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -422,7 +436,7 @@
         },
         {
           "name": "edit-chart-state",
-          "description": "When disabled, interaction with the edit chart action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the edit chart action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -439,7 +453,7 @@
         },
         {
           "name": "edit-chart-toggle",
-          "description": "When active, the edit chart action is highlighted.",
+          "description": "When `active`, the edit chart action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -456,7 +470,7 @@
         },
         {
           "name": "export-action-state",
-          "description": "When disabled, interaction with the export action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the export action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -468,7 +482,7 @@
         },
         {
           "name": "export-as-csv-state",
-          "description": "When disabled, interaction with the download CSV is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the download CSV is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -485,7 +499,7 @@
         },
         {
           "name": "export-as-image-state",
-          "description": "When disabled, interaction with the download image is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the download image is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -502,7 +516,7 @@
         },
         {
           "name": "filter-by-extent-state",
-          "description": "When disabled, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -519,7 +533,7 @@
         },
         {
           "name": "filter-by-extent-toggle",
-          "description": "When active, the filter by extent action is highlighted.",
+          "description": "When `active`, the filter by extent action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -531,7 +545,7 @@
         },
         {
           "name": "filter-by-selection-state",
-          "description": "When disabled, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -548,7 +562,7 @@
         },
         {
           "name": "filter-by-selection-toggle",
-          "description": "When active, the filter by selection action is highlighted.",
+          "description": "When `active`, the filter by selection action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -565,7 +579,7 @@
         },
         {
           "name": "full-extent-state",
-          "description": "When disabled, interaction with the full extent action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the full extent action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -582,7 +596,7 @@
         },
         {
           "name": "full-extent-toggle",
-          "description": "When active, the full extent action is highlighted.",
+          "description": "When `active`, the full extent action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -594,7 +608,7 @@
         },
         {
           "name": "legend-state",
-          "description": "When disabled, interaction with the legend action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the legend action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -611,7 +625,7 @@
         },
         {
           "name": "legend-toggle",
-          "description": "When active, the legend action is highlighted.",
+          "description": "When `active`, the legend action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -623,7 +637,7 @@
         },
         {
           "name": "rotate-chart-state",
-          "description": "When disabled, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -640,7 +654,7 @@
         },
         {
           "name": "rotate-chart-toggle",
-          "description": "When active, the rotate chart action is highlighted.",
+          "description": "When `active`, the rotate chart action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -652,7 +666,7 @@
         },
         {
           "name": "selection-state",
-          "description": "When disabled, interaction with the selection action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the selection action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -669,7 +683,7 @@
         },
         {
           "name": "selection-toggle",
-          "description": "When active, the selection action is highlighted.",
+          "description": "When `active`, the selection action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -681,7 +695,7 @@
         },
         {
           "name": "switch-selection-state",
-          "description": "When disabled, interaction with the switch selection action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the switch selection action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -698,7 +712,7 @@
         },
         {
           "name": "switch-selection-toggle",
-          "description": "When active, the switch selection action is highlighted.",
+          "description": "When `active`, the switch selection action is highlighted.",
           "values": [
             {
               "name": "active"
@@ -710,7 +724,7 @@
         },
         {
           "name": "zoom-state",
-          "description": "When disabled, interaction with the zoom action is prevented and the component is displayed with lower opacity.",
+          "description": "When `disabled`, interaction with the zoom action is prevented and the component is displayed with lower opacity.",
           "values": [
             {
               "name": "disabled"
@@ -727,7 +741,7 @@
         },
         {
           "name": "zoom-toggle",
-          "description": "When active, the zoom action is highlighted.",
+          "description": "When `active`, the zoom action is highlighted.",
           "values": [
             {
               "name": "active"