@arcgis/charts-components 4.33.0-next.112 → 4.33.0-next.117

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.33.0-next.112",
+  "version": "4.33.0-next.117",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "name": "arcgis-chart",
-          "description": "Chart component renders various chart types based on the provided model, including bar charts, line charts, pie charts, box plots, combo bar-line charts, gauges, scatterplots, and histograms.\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- `exportImage(props: { format: \"jpg\" | \"png\"; quality?: number; maxWidth?: number; minWidth?: number; maxHeight?: number; minHeight?: number; }): Promise<File>` - Export the current chart to 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** - A slot for adding charts-action-bar component or calcite-action-bar.",
+          "description": "Chart component renders various chart types based on the provided model, including bar charts, line charts, pie charts, box plots, combo bar-line charts, gauges, scatterplots, and histograms.\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- `exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>` - Export the current chart as an image.\n- `exportImage(props: { format: \"jpg\" | \"png\"; quality?: number; maxWidth?: number; minWidth?: number; maxHeight?: number; minHeight?: number; }): Promise<File>` - Export the current chart to 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** - A slot for adding charts-action-bar component or calcite-action-bar.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/",
           "attributes": [
             {
@@ -821,6 +821,14 @@
                 ]
               }
             },
+            {
+              "name": "disabled-export-action",
+              "description": "When `true`, the export action is disabled.",
+              "default": "false",
+              "value": {
+                "type": "boolean"
+              }
+            },
             {
               "name": "edit-chart-state",
               "description": "When disabled, interaction with the edit chart action is prevented and the component is displayed with lower opacity.",
@@ -859,6 +867,25 @@
                 "type": "boolean"
               }
             },
+            {
+              "name": "export-as-image-state",
+              "description": "When disabled, interaction with the download image is prevented and the component is displayed with lower opacity.",
+              "default": "\"enabled\"",
+              "value": {
+                "type": [
+                  "\"disabled\"",
+                  "\"enabled\""
+                ]
+              }
+            },
+            {
+              "name": "export-as-image-title",
+              "description": "Custom title for the download chart action.",
+              "default": "undefined",
+              "value": {
+                "type": "string"
+              }
+            },
             {
               "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.",
@@ -1162,6 +1189,11 @@
                 "description": "When active, the clear selection action is highlighted.",
                 "type": "\"active\" | \"inactive\""
               },
+              {
+                "name": "disabledExportAction",
+                "description": "When `true`, the export action is disabled.",
+                "type": "boolean"
+              },
               {
                 "name": "editChartState",
                 "description": "When disabled, interaction with the edit chart action is prevented and the component is displayed with lower opacity.",
@@ -1182,6 +1214,16 @@
                 "description": "When `true`, the action bar is expanded.",
                 "type": "boolean"
               },
+              {
+                "name": "exportAsImageState",
+                "description": "When disabled, interaction with the download image is prevented and the component is displayed with lower opacity.",
+                "type": "\"disabled\" | \"enabled\""
+              },
+              {
+                "name": "exportAsImageTitle",
+                "description": "Custom title for the download chart action.",
+                "type": "string"
+              },
               {
                 "name": "filterByExtentState",
                 "description": "When disabled, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.",
@@ -1235,7 +1277,7 @@
               {
                 "name": "hiddenActions",
                 "description": "Holds a list of actions to hide from the action bar.\n\n**Note:** The edit chart action is hidden by default. To show it, remove its value from this array.",
-                "type": "Array<\"legend\" | \"fullExtent\" | \"filterBySelection\" | \"filterByExtent\" | \"rotateChart\" | \"selection\" | \"clearSelection\" | \"switchSelection\" | \"zoom\" | \"editChart\">"
+                "type": "Array<\"legend\" | \"fullExtent\" | \"filterBySelection\" | \"filterByExtent\" | \"rotateChart\" | \"selection\" | \"clearSelection\" | \"switchSelection\" | \"zoom\" | \"editChart\" | \"exportAsImage\">"
               },
               {
                 "name": "legendState",
@@ -1255,7 +1297,7 @@
               {
                 "name": "messageOverrides",
                 "description": "Overwrite localized strings for this component",
-                "type": "{\n    legend?: string | undefined;\n    rotateChart?: string | undefined;\n    filterBySelection?: string | undefined;\n    filterByExtent?: string | undefined;\n    selection?: string | undefined;\n    zoom?: string | undefined;\n    fullExtent?: string | undefined;\n    clearSelection?: string | undefined;\n    switchSelection?: string | undefined;\n    expand?: string | undefined;\n    collapse?: string | undefined;\n}"
+                "type": "{\n    legend?: string | undefined;\n    rotateChart?: string | undefined;\n    filterBySelection?: string | undefined;\n    filterByExtent?: string | undefined;\n    selection?: string | undefined;\n    zoom?: string | undefined;\n    fullExtent?: string | undefined;\n    clearSelection?: string | undefined;\n    switchSelection?: string | undefined;\n    expand?: string | undefined;\n    collapse?: string | undefined;\n    exportAsImage?: string | undefined;\n    export?: string | undefined;\n}"
               },
               {
                 "name": "rotateChartState",