@arcgis/charts-components 5.0.0-next.90 → 5.0.0-next.92

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

@@ -4,7 +4,7 @@
   "tags": [
     {
       "name": "arcgis-chart",
-      "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.\nOnly supported for pie chart at the moment.\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- **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`.",
+      "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",
@@ -34,17 +34,17 @@
         },
         {
           "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.",
+          "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": "**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.",
+          "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 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.\n\n**Note**: Only applicable to bar chart.",
+          "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": []
         },
         {
@@ -77,6 +77,11 @@
           "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": []
+        },
         {
           "name": "enable-configuration",
           "description": "Whether to use features uniquely designed for a chart currently being configured by a user via the UI.",
@@ -131,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`.\n\n**Note**: Applicable to line chart only.",
+          "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"
@@ -205,7 +210,7 @@
         },
         {
           "name": "null-as-valid",
-          "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`)",
+          "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": []
         },
         {
@@ -225,7 +230,7 @@
         },
         {
           "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`.\n\n**Note**: Not applicable to gauge.",
+          "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": []
         },
         {