@arcgis/charts-components 4.34.0-next.90 → 4.34.0-next.96

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

@@ -4,7 +4,7 @@
   "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- **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- `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 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- `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`.",
       "attributes": [
         {
           "name": "action-mode",
@@ -42,6 +42,11 @@
           "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.",
           "values": []
         },
+        {
+          "name": "chart-index",
+          "description": "The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.\n\nIf a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nIf the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.",
+          "values": []
+        },
         {
           "name": "component-version",
           "description": "Whether to use the stable version of the component or the beta version.",
@@ -165,6 +170,11 @@
             }
           ]
         },
+        {
+          "name": "layer-item-id",
+          "description": "Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.\n\nIf `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.",
+          "values": []
+        },
         {
           "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.",

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": "4.34.0-next.90",
+  "version": "4.34.0-next.96",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "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- **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- `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 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- `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`.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/",
           "attributes": [
             {
@@ -49,6 +49,14 @@
                 "type": "boolean"
               }
             },
+            {
+              "name": "chart-index",
+              "description": "The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.\n\nIf a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nIf the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.",
+              "default": "undefined",
+              "value": {
+                "type": "number"
+              }
+            },
             {
               "name": "component-version",
               "description": "Whether to use the stable version of the component or the beta version.",
@@ -201,6 +209,14 @@
                 ]
               }
             },
+            {
+              "name": "layer-item-id",
+              "description": "Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.\n\nIf `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.",
+              "default": "undefined",
+              "value": {
+                "type": "string"
+              }
+            },
             {
               "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.",
@@ -369,6 +385,11 @@
               "type": "DataWarningObject",
               "description": "Event triggered when an error is detected with the data set"
             },
+            {
+              "name": "arcgisChartNotFoundWarning",
+              "type": "string",
+              "description": "Event triggered when the chart is not found for the given `chartIndex` property."
+            },
             {
               "name": "arcgisConfigChange",
               "type": "{\n    newConfig: WebChart | undefined;\n    oldConfig: WebChart | undefined;\n    functionCalled: string | undefined;\n}",
@@ -447,6 +468,11 @@
                 "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.",
                 "type": "boolean"
               },
+              {
+                "name": "chartIndex",
+                "description": "The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.\n\nIf a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nIf the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.",
+                "type": "number"
+              },
               {
                 "name": "chartLimits",
                 "description": "Used to customize the number maximum of bars allowed on the chart.\nThe chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation\nor update of the chart, or render the elements up to the given limits.",
@@ -567,6 +593,11 @@
                 "description": "Whether the chart should be refreshed when the layer's filter (`definitionExpression`) changes.",
                 "type": "\"ignore\" | \"refresh\""
               },
+              {
+                "name": "layerItemId",
+                "description": "Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.\n\nIf `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.",
+                "type": "string"
+              },
               {
                 "name": "layerRendererChangePolicy",
                 "description": "Allows the chart to update automatically when the layer's renderer changes.\nApplies when the color match feature is enabled.",
@@ -729,6 +760,11 @@
                 "type": "DataWarningObject",
                 "description": "Event triggered when an error is detected with the data set"
               },
+              {
+                "name": "arcgisChartNotFoundWarning",
+                "type": "string",
+                "description": "Event triggered when the chart is not found for the given `chartIndex` property."
+              },
               {
                 "name": "arcgisConfigChange",
                 "type": "{\n    newConfig: WebChart | undefined;\n    oldConfig: WebChart | undefined;\n    functionCalled: string | undefined;\n}",

package/dist/index.d.ts

@@ -33,6 +33,7 @@ declare global {
   interface HTMLArcgisChartElementEventMap {
     "arcgisAxesMinMaxChange": ArcgisChart["arcgisAxesMinMaxChange"]["detail"];
     "arcgisBadDataWarningRaise": ArcgisChart["arcgisBadDataWarningRaise"]["detail"];
+    "arcgisChartNotFoundWarning": ArcgisChart["arcgisChartNotFoundWarning"]["detail"];
     "arcgisConfigChange": ArcgisChart["arcgisConfigChange"]["detail"];
     "arcgisDataFetchComplete": ArcgisChart["arcgisDataFetchComplete"]["detail"];
     "arcgisDataProcessComplete": ArcgisChart["arcgisDataProcessComplete"]["detail"];