@arcgis/charts-components 5.0.0-next.126 → 5.0.0-next.128

package/dist/docs/web-types.json

@@ -1,14 +1,14 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@arcgis/charts-components",
-  "version": "5.0.0-next.126",
+  "version": "5.0.0-next.128",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "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.\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- **arcgisInvalidConfigWarningRaise** - Event triggered when an invalid configuration is detected.\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<this>` - 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**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): 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- **arcgisInvalidConfigWarningRaise** - Event triggered when an invalid configuration is detected.\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<this>` - 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. Default format is `png`.\n- Alternative formats supported are: `jpeg` and `svg`.\n- `loadModel(): Promise<void>` - Returns a promise that resolves when the chart model is fully loaded.\n- `notify(message?: string, heading?: string): 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`.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/",
           "attributes": [
             {
@@ -34,7 +34,7 @@
             },
             {
               "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": "When `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.",
               "default": "false",
               "value": {
                 "type": "boolean"
@@ -76,7 +76,7 @@
             },
             {
               "name": "disable-auto-theming",
-              "description": "Whether to disable the auto-theming of the chart based on the Calcite themes. Currently only the dark theme is supported.\nBy default the chart component will apply the Calcite theme if detected on its container or on a parent element.",
+              "description": "Whether to disable automatic chart theming based on Calcite theme detection.\n\n**Note**: Currently, only the `calcite-mode-dark` theme is supported. When this theme\nis applied, all chart colors are automatically adjusted for dark mode and\nany custom chart colors will be overridden. This includes series, axes, grid and other elements.\n\nWhen `true`, the chart component will not apply any Calcite-based theming,\neven if a supported Calcite theme is detected.\n\nWhen `false` (default), the chart component will automatically apply the\nsupported Calcite theme if it is detected on the chart container or any\nparent element.",
               "default": "false",
               "value": {
                 "type": "boolean"
@@ -227,7 +227,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.\n\n**Note**: If the property is set to `ignore` the chart will use the layer's renderer information when the data is updated.",
+              "description": "Allows the chart to update automatically when the layer's renderer changes.\n\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.",
               "default": "\"refresh\"",
               "value": {
                 "type": [
@@ -273,7 +273,7 @@
             },
             {
               "name": "queue-chart-creation",
-              "description": "Builds the charts one by one rather than all at the same time.",
+              "description": "Builds charts sequentially instead of rendering them all at once",
               "default": "false",
               "value": {
                 "type": "boolean"
@@ -289,7 +289,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\n\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.",
               "default": "false",
               "value": {
                 "type": "boolean"
@@ -363,7 +363,7 @@
             },
             {
               "name": "use-animated-charts",
-              "description": "Enables the animations on the chart.",
+              "description": "Enable animation on the chart.",
               "default": "false",
               "value": {
                 "type": "boolean"
@@ -371,7 +371,7 @@
             },
             {
               "name": "use-popup-template-fields-info",
-              "description": "Allows the use of the fields alias from the layer.popupTemplate when rendering the field names on the chart (e.g. tooltips, axes, legend).",
+              "description": "Allows the use of the fields alias from the `layer.popupTemplate` when rendering the field names on the chart (e.g. tooltips, axes, legend).",
               "default": "false",
               "value": {
                 "type": "boolean"
@@ -491,7 +491,7 @@
               },
               {
                 "name": "autoDestroyDisabled",
-                "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": "When `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.",
                 "type": "boolean"
               },
               {
@@ -531,7 +531,7 @@
               },
               {
                 "name": "disableAutoTheming",
-                "description": "Whether to disable the auto-theming of the chart based on the Calcite themes. Currently only the dark theme is supported.\nBy default the chart component will apply the Calcite theme if detected on its container or on a parent element.",
+                "description": "Whether to disable automatic chart theming based on Calcite theme detection.\n\n**Note**: Currently, only the `calcite-mode-dark` theme is supported. When this theme\nis applied, all chart colors are automatically adjusted for dark mode and\nany custom chart colors will be overridden. This includes series, axes, grid and other elements.\n\nWhen `true`, the chart component will not apply any Calcite-based theming,\neven if a supported Calcite theme is detected.\n\nWhen `false` (default), the chart component will automatically apply the\nsupported Calcite theme if it is detected on the chart container or any\nparent element.",
                 "type": "boolean"
               },
               {
@@ -636,7 +636,7 @@
               },
               {
                 "name": "layerRendererChangePolicy",
-                "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.",
+                "description": "Allows the chart to update automatically when the layer's renderer changes.\n\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.",
                 "type": "\"ignore\" | \"refresh\""
               },
               {
@@ -661,7 +661,7 @@
               },
               {
                 "name": "messageOverrides",
-                "description": "Custom message overrides for the chart's strings.\\",
+                "description": "Custom message overrides for the chart's strings.",
                 "type": "Record<string, unknown>"
               },
               {
@@ -681,7 +681,7 @@
               },
               {
                 "name": "queueChartCreation",
-                "description": "Builds the charts one by one rather than all at the same time.",
+                "description": "Builds charts sequentially instead of rendering them all at once",
                 "type": "boolean"
               },
               {
@@ -691,7 +691,7 @@
               },
               {
                 "name": "returnFeaturesExtent",
-                "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.",
+                "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.",
                 "type": "boolean"
               },
               {
@@ -766,12 +766,12 @@
               },
               {
                 "name": "useAnimatedCharts",
-                "description": "Enables the animations on the chart.",
+                "description": "Enable animation on the chart.",
                 "type": "boolean"
               },
               {
                 "name": "usePopupTemplateFieldsInfo",
-                "description": "Allows the use of the fields alias from the layer.popupTemplate when rendering the field names on the chart (e.g. tooltips, axes, legend).",
+                "description": "Allows the use of the fields alias from the `layer.popupTemplate` when rendering the field names on the chart (e.g. tooltips, axes, legend).",
                 "type": "boolean"
               },
               {
@@ -786,7 +786,7 @@
               },
               {
                 "name": "xAxisLabelFormatter",
-                "description": "Indicates whether to show the ArcGIS charts notify panel. False by default\nA callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to pie chart.",
+                "description": "A callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to pie chart.",
                 "type": "(((value: string | number | Date | null, originalValue?: WebChartDataItemValue) => string))"
               },
               {
@@ -1523,9 +1523,9 @@
           }
         },
         {
-          "name": "arcgis-charts-config-info-modal",
+          "name": "arcgis-charts-info-modal",
           "description": "### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
-          "doc-url": "https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-charts-config-info-modal/",
+          "doc-url": "https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-charts-info-modal/",
           "attributes": [
             {
               "name": "heading",

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import type { ArcgisChart } from "./components/arcgis-chart/customElement.js";
 import type { ArcgisChartsActionBar } from "./components/arcgis-charts-action-bar/customElement.js";
-import type { ArcgisChartsConfigInfoModal } from "./components/arcgis-charts-config-info-modal/customElement.js";
+import type { ArcgisChartsInfoModal } from "./components/arcgis-charts-info-modal/customElement.js";
 
 /** @public */
 export * from './spec/index';
@@ -38,7 +38,7 @@ declare global {
   interface HTMLElementTagNameMap {
     "arcgis-chart": ArcgisChart;
     "arcgis-charts-action-bar": ArcgisChartsActionBar;
-    "arcgis-charts-config-info-modal": ArcgisChartsConfigInfoModal;
+    "arcgis-charts-info-modal": ArcgisChartsInfoModal;
   }
 
   type HTMLArcgisChartElementEventMap = ArcgisChart["@eventTypes"];
@@ -49,7 +49,7 @@ declare global {
   type HTMLArcgisChartsActionBarElement = ArcgisChartsActionBar;
 
 
-  type HTMLArcgisChartsConfigInfoModalElement = ArcgisChartsConfigInfoModal;
+  type HTMLArcgisChartsInfoModalElement = ArcgisChartsInfoModal;
 
 
 }