@arcgis/charts-components 4.34.0-next.99 → 4.34.0

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.99",
+  "version": "4.34.0",
   "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- **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`.",
+          "description": "The ArcGIS 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\nSee also:\n- [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)\n- [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)\n- [Tutorial: Create a heat chart](https://developers.arcgis.com/javascript/latest/tutorials/create-a-heat-chart/)\n- [Tutorial: Modify a chart](https://developers.arcgis.com/javascript/latest/tutorials/modify-a-chart/)\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; }): 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": [
             {
@@ -28,7 +28,7 @@
             {
               "name": "allow-using-object-id-stat",
               "description": "Whether to allow the object id to be used as a statistic other than COUNT.",
-              "default": "undefined",
+              "default": "false",
               "value": {
                 "type": "boolean"
               }
@@ -57,17 +57,6 @@
                 "type": "number"
               }
             },
-            {
-              "name": "component-version",
-              "description": "Whether to use the stable version of the component or the beta version.",
-              "default": "\"stable\"",
-              "value": {
-                "type": [
-                  "\"beta\"",
-                  "\"stable\""
-                ]
-              }
-            },
             {
               "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",
@@ -249,6 +238,14 @@
                 "type": "boolean"
               }
             },
+            {
+              "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`)",
+              "default": "false",
+              "value": {
+                "type": "boolean"
+              }
+            },
             {
               "name": "placeholder",
               "description": "A placeholder string to provides a brief hint to the user indicating needed information for creating a chart.",
@@ -313,6 +310,14 @@
                 "type": "boolean"
               }
             },
+            {
+              "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).",
+              "default": "undefined",
+              "value": {
+                "type": "boolean"
+              }
+            },
             {
               "name": "sync-selection",
               "description": "Whether to synchronize the selection between chart components from the same layer.",
@@ -417,7 +422,7 @@
             },
             {
               "name": "arcgisNoRenderPropChange",
-              "type": "{\n    propName: string;\n    value: number | boolean | MapView | SceneView | WebChartLegendPositions | undefined;\n    model: ChartModel | undefined;\n}",
+              "type": "{\n    propName: string;\n    value: number | boolean | WebChartLegendPositions | MapView | SceneView | undefined;\n    model: ChartModel | undefined;\n}",
               "description": "Event triggered when a no-render prop is changed"
             },
             {
@@ -483,11 +488,6 @@
                 "description": "Lifecycle function executed after the data has been processed and before the chart renders.\nCan be used to alter the config from information extracted from the data for instance.",
                 "type": "(((props: {\n    chartConfig: WebChart | WebGaugeChart;\n    data?: WebChartDataTypes | undefined;\n    slices?: Array<WebChartPieChartSlice> | undefined;\n}) => Promise<WebChart | WebGaugeChart>))"
               },
-              {
-                "name": "componentVersion",
-                "description": "Whether to use the stable version of the component or the beta version.",
-                "type": "\"beta\" | \"stable\""
-              },
               {
                 "name": "cursorRange",
                 "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",
@@ -496,7 +496,7 @@
               {
                 "name": "dataLabelFormatter",
                 "description": "A callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.",
-                "type": "(((category: string, value?: number | undefined, percent?: number | undefined, originalCategory?: WebChartDataItemValue) => string)) | (((count: number, binMinValue: number, binMaxValue: number) => string)) | (((statValue: number, percent?: number | undefined) => string)) | (((x: number, y: number, sizePolicyValue?: number | undefined) => string))"
+                "type": "(((category: string, value?: number | undefined, percent?: number | undefined, originalCategory?: WebChartDataItemValue) => string)) | (((count: number, binMinValue: number, binMaxValue: number) => string)) | (((statValue: number, percent?: number | undefined) => string)) | (((x: number, y: number, sizePolicyValue?: number | undefined, dataContext?: WebChartDataItem | undefined) => string))"
               },
               {
                 "name": "disableInteractions",
@@ -508,11 +508,6 @@
                 "description": "Disables the toggling of series via the legend items.",
                 "type": "boolean"
               },
-              {
-                "name": "displaySettings",
-                "description": "Used to set the options available to handle messages displayed on the chart.",
-                "type": "DisplaySettings"
-              },
               {
                 "name": "enableConfiguration",
                 "description": "Whether to use features uniquely designed for a chart currently being configured by a user via the UI.",
@@ -625,19 +620,19 @@
               },
               {
                 "name": "model",
-                "description": "Instance of an ArcGIS Chart Model. Provides an API to interact with the chart's configuration.\n\n**Note:** This property has a union type of `ChartModel | WebChart` meaning a raw chart config object can be passed to it instead, however it is recommended to use a `ChartModel` instance whenever possible.",
+                "description": "Instance of an ArcGIS Chart Model. Provides an API to interact with the chart's configuration.\n**Note:** This property has a union type of `ChartModel | WebChart` meaning a raw chart config object can be passed to it instead, however it is recommended to use a `ChartModel` instance whenever possible.",
                 "type": "ChartModel | WebChart"
               },
+              {
+                "name": "nullAsValid",
+                "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`)",
+                "type": "boolean"
+              },
               {
                 "name": "placeholder",
                 "description": "A placeholder string to provides a brief hint to the user indicating needed information for creating a chart.",
                 "type": "string"
               },
-              {
-                "name": "querySettings",
-                "description": "Used to set the options available to query data for the chart.",
-                "type": "QuerySettings"
-              },
               {
                 "name": "queueChartCreation",
                 "description": "Builds the charts one by one rather than all at the same time.",
@@ -671,7 +666,7 @@
               {
                 "name": "runtimeDataFilters",
                 "description": "Applies runtime data filters to the chart's.",
-                "type": "{\n    distance?: number | undefined;\n    gdbVersion?: string | undefined;\n    geometry?: IExtent | IEnvelope | IPoint | IPolygon | IPolygonWithCurves | IPolyline | undefined;\n    objectIds?: Array<number> | undefined;\n    spatialRelationship?: \"intersects\" | \"contains\" | \"crosses\" | \"disjoint\" | \"envelope-intersects\" | \"index-intersects\" | \"overlaps\" | \"touches\" | \"within\" | \"relation\" | undefined;\n    timeExtent?: [number, number] | undefined;\n    units?: RESTUnits | undefined;\n    where?: string | undefined;\n}"
+                "type": "{\n    spatialRelationship?: \"intersects\" | \"contains\" | \"crosses\" | \"disjoint\" | \"envelope-intersects\" | \"index-intersects\" | \"overlaps\" | \"touches\" | \"within\" | \"relation\" | undefined;\n    distance?: number | undefined;\n    gdbVersion?: string | undefined;\n    geometry?: IPoint | IPolyline | IPolygon | IPolygonWithCurves | IEnvelope | IExtent | undefined;\n    objectIds?: Array<number> | undefined;\n    timeExtent?: [number, number] | undefined;\n    units?: RESTUnits | undefined;\n    where?: string | undefined;\n}"
               },
               {
                 "name": "secondaryYAxisLabelFormatter",
@@ -693,6 +688,11 @@
                 "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.",
                 "type": "boolean"
               },
+              {
+                "name": "showUIMessages",
+                "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).",
+                "type": "boolean"
+              },
               {
                 "name": "syncSelection",
                 "description": "Whether to synchronize the selection between chart components from the same layer.",
@@ -711,7 +711,7 @@
               {
                 "name": "tooltipFormatter",
                 "description": "A callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.",
-                "type": "(((category: string, value?: number | undefined, percent?: number | undefined, originalCategory?: WebChartDataItemValue) => string)) | (((count: number, binMinValue: number, binMaxValue: number) => string)) | (((props: BarAndLineTooltipFormatCallbackProps) => string)) | (((props: BoxPlotTooltipFormatCallbackProps) => string)) | (((x: number, y: number, sizePolicyValue?: number | undefined) => string))"
+                "type": "(((category: string, value?: number | undefined, percent?: number | undefined, originalCategory?: WebChartDataItemValue) => string)) | (((count: number, binMinValue: number, binMaxValue: number) => string)) | (((props: BarAndLineTooltipFormatCallbackProps) => string)) | (((props: BoxPlotTooltipFormatCallbackProps) => string)) | (((x: number, y: number, sizePolicyValue?: number | undefined, dataContext?: WebChartDataItem | undefined) => string))"
               },
               {
                 "name": "updateSplitBySeries",
@@ -792,7 +792,7 @@
               },
               {
                 "name": "arcgisNoRenderPropChange",
-                "type": "{\n    propName: string;\n    value: number | boolean | MapView | SceneView | WebChartLegendPositions | undefined;\n    model: ChartModel | undefined;\n}",
+                "type": "{\n    propName: string;\n    value: number | boolean | WebChartLegendPositions | MapView | SceneView | undefined;\n    model: ChartModel | undefined;\n}",
                 "description": "Event triggered when a no-render prop is changed"
               },
               {
@@ -825,7 +825,7 @@
         },
         {
           "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 ArcGIS Charts Action Bar component enhances chart functionality by providing 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\nSee also:\n- [Tutorial: Chart and map interactions](https://developers.arcgis.com/javascript/latest/tutorials/chart-and-map-interactions/)\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.",
           "doc-url": "https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-charts-action-bar/",
           "attributes": [
             {
@@ -1282,7 +1282,7 @@
               {
                 "name": "disableCSVExportForChartTypes",
                 "description": "The CSV export action is disabled for certain chart types.\n\nModify this property to add or remove chart types from the list of disabled types.",
-                "type": "Array<\"number\" | \"cursorCrosshair\" | \"chartText\" | \"category\" | \"date\" | \"chartAxis\" | \"chartLegend\" | \"chartOverlay\" | \"chart\" | \"sizeScale\" | \"chartOverlays\" | \"scatterSeries\" | \"gaugeAxisTick\" | \"gaugeNeedle\" | \"chartGuide\" | \"pieSeries\" | \"pieTick\" | \"gaugeSeries\" | \"lineSeries\" | \"barSeries\" | \"histogramSeries\" | \"boxPlotSeries\" | \"radarSeries\" | \"comboLineAndBarSeries\" | \"heatSeries\" | \"buffer\" | \"calendarDateParts\">"
+                "type": "Array<\"number\" | \"chart\" | \"chartText\" | \"chartOverlay\" | \"chartOverlays\" | \"chartLegend\" | \"cursorCrosshair\" | \"chartAxis\" | \"gaugeAxisTick\" | \"gaugeNeedle\" | \"category\" | \"date\" | \"chartGuide\" | \"scatterSeries\" | \"pieSeries\" | \"pieTick\" | \"gaugeSeries\" | \"lineSeries\" | \"barSeries\" | \"histogramSeries\" | \"boxPlotSeries\" | \"radarSeries\" | \"comboLineAndBarSeries\" | \"heatSeries\" | \"buffer\" | \"sizeScale\" | \"calendarDateParts\">"
               },
               {
                 "name": "editChartState",
@@ -1382,7 +1382,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<\"zoom\" | \"editChart\" | \"legend\" | \"fullExtent\" | \"filterBySelection\" | \"filterByExtent\" | \"rotateChart\" | \"selection\" | \"clearSelection\" | \"switchSelection\" | \"exportAsImage\" | \"exportAsCSV\">"
+                "type": "Array<\"legend\" | \"zoom\" | \"editChart\" | \"fullExtent\" | \"filterBySelection\" | \"filterByExtent\" | \"rotateChart\" | \"selection\" | \"clearSelection\" | \"switchSelection\" | \"exportAsImage\" | \"exportAsCSV\">"
               },
               {
                 "name": "legendState",

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 import type { ArcgisChart } from "./components/arcgis-chart";
 import type { ArcgisChartsActionBar } from "./components/arcgis-charts-action-bar";
 
-export type { WebChart } from '@arcgis/charts-spec';
-export * from './utils';
+export * from './spec/index';
+export * from './utils/index';
+export * from './model/index';
 export type { PanelNumberChangePayload, DataChangeErrorPayload, PopoverOpenChangePayload, ModelListChangePayload, DataProcessCompletePayload, AxesMinMaxChangePayload, SeriesColorChangePayload, NoRenderPropChangePayload, LegendItemVisibilityChangePayload, DefaultActionSelectPayload, SelectionCompletePayload, } from './utils/components/event-payloads';
-export type { AxisLabelFormatCallback, ChartOptions, DisplaySettings, QuerySettings, GaugeInnerLabelFormatCallback, GuideTooltipFormatCallback, NotifyOptions, PieChartLegendValueLabelFormatCallback, PreRenderCallback, } from './chart-rendering/common/interfaces';
+export type { AxisLabelFormatCallback, ChartOptions, GaugeInnerLabelFormatCallback, GuideTooltipFormatCallback, NotifyOptions, PieChartLegendValueLabelFormatCallback, PreRenderCallback, } from './chart-rendering/common/interfaces';
 export { BarChartDataPopoverKinds, BoxPlotDataPopoverKinds, ChartAuthoringPages, HistogramDataPopoverKinds, type IntervalPopoverProps, LineChartDataPopoverKinds, PieChartDataPopoverKinds, ScatterplotDataPopoverKinds, } from './interfaces';
 export type { FontStyleChangePayload } from './components/arcgis-charts-config-font-style/resource';
 export type { GuideChangePayload } from './components/arcgis-charts-config-guide/resource';