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

package/dist/store.d.ts

@@ -39,12 +39,12 @@ declare const state: {
     timeBinningIntervalMap: {};
 };
 /**
- * Generates the min max axis key for the selected chart based on the axis type and logarithmic scale.
- * The key is used to fetch/store the min max axis related values in the state for the selected chart
+ * Generates the min/max axis key for the selected chart based on the axis type and logarithmic scale.
+ * The key is used to fetch/store the min/max axis related values in the state for the selected chart.
  *
- * @param {string} props.chartId - The selected chart id
- * @param {boolean} props.isXAxis - The axis type (`true` for x-axis, `false` for y-axis)
- * @param {boolean} props.isLogarithmic - The axis scale (`true` for logarithmic)
+ * @param props.chartId - The selected chart id
+ * @param props.isXAxis - The axis type (`true` for x-axis, `false` for y-axis)
+ * @param props.isLogarithmic - The axis scale (`true` for logarithmic)
  */
 export declare const generateAxisMinMaxKey: (props: {
     chartId: string;
@@ -52,26 +52,29 @@ export declare const generateAxisMinMaxKey: (props: {
     isLogarithmic: boolean;
 }) => string;
 /**
- * Deletes the min max axis key from the state for the selected chart
+ * Deletes the min/max axis key from the state for the selected chart.
  *
- * @param {AppState} appState - The current app state
+ * @param appState - The current app state
  */
 export declare const deleteMinMaxAxisKey: (appState: AppState) => void;
 /**
- * Gets the axes bound data for the selected chart
- * @param {AppState} appState - The current app state
- * @returns {TimeIntervalInfo | undefined} - The axes bound data map for the selected chart
+ * Gets the axes bound data for the selected chart.
+ *
+ * @param appState - The current app state
+ * @returns The axes bound data map for the selected chart
  */
 export declare const getTimeBinningForChart: (appState: AppState) => TimeIntervalInfo | undefined;
 /**
- * Sets the time binning interval for a specific chart
- * @param {AppState} appState - The current app state
- * @param {TimeIntervalInfo} timeBinning - The time binning interval to set
+ * Sets the time binning interval for a specific chart.
+ *
+ * @param appState - The current app state
+ * @param timeBinning - The time binning interval to set
  */
 export declare const setTimeBinningForChart: (appState: AppState, timeBinning: TimeIntervalInfo) => void;
 /**
- * Resets the time binning interval for a specific chart
- * @param {AppState} appState - The current app state
+ * Resets the time binning interval for a specific chart.
+ *
+ * @param appState - The current app state
  */
 export declare const resetTimeBinningForChart: (appState: AppState) => void;
 export default state;

package/dist/types/lumina.d.ts

@@ -3,7 +3,7 @@ import type { ArcgisChart } from "../components/arcgis-chart/index.js";
 import type { ArcgisChartsActionBar } from "../components/arcgis-charts-action-bar/index.js";
 import type { h, EventHandler } from "@arcgis/lumina";
 
-interface LuminaArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, h.JSX.HTMLAttributes<HTMLArcgisChartElement> {
+interface LuminaArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableBetaFeatures' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, h.JSX.HTMLAttributes<HTMLArcgisChartElement> {
   onarcgisAxesMinMaxChange?: EventHandler<HTMLArcgisChartElement["arcgisAxesMinMaxChange"]>;
   onarcgisBadDataWarningRaise?: EventHandler<HTMLArcgisChartElement["arcgisBadDataWarningRaise"]>;
   onarcgisChartNotFoundWarning?: EventHandler<HTMLArcgisChartElement["arcgisChartNotFoundWarning"]>;

package/dist/types/preact.d.ts

@@ -4,7 +4,7 @@ import type { ArcgisChartsActionBar } from "../components/arcgis-charts-action-b
 import { HTMLAttributes } from "preact";
 import type { EventHandler } from "@arcgis/lumina";
 
-interface PreactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, HTMLAttributes<HTMLArcgisChartElement> {
+interface PreactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableBetaFeatures' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, HTMLAttributes<HTMLArcgisChartElement> {
   onarcgisAxesMinMaxChange?: EventHandler<HTMLArcgisChartElement["arcgisAxesMinMaxChange"]>;
   onarcgisBadDataWarningRaise?: EventHandler<HTMLArcgisChartElement["arcgisBadDataWarningRaise"]>;
   onarcgisChartNotFoundWarning?: EventHandler<HTMLArcgisChartElement["arcgisChartNotFoundWarning"]>;

package/dist/types/preact10.d.ts

@@ -5,7 +5,7 @@ import { JSX as PreactJsx } from "preact";
 import type { EventHandler } from "@arcgis/lumina";
 
 /** @deprecated Update to Preact 10.27.2+ or 11+ and consume types/preact file over types/preact10 */
-interface PreactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, PreactJsx.HTMLAttributes<HTMLArcgisChartElement> {
+interface PreactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableBetaFeatures' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, PreactJsx.HTMLAttributes<HTMLArcgisChartElement> {
   onarcgisAxesMinMaxChange?: EventHandler<HTMLArcgisChartElement["arcgisAxesMinMaxChange"]>;
   onarcgisBadDataWarningRaise?: EventHandler<HTMLArcgisChartElement["arcgisBadDataWarningRaise"]>;
   onarcgisChartNotFoundWarning?: EventHandler<HTMLArcgisChartElement["arcgisChartNotFoundWarning"]>;

package/dist/types/react.d.ts

@@ -4,7 +4,7 @@ import type { ArcgisChartsActionBar } from "../components/arcgis-charts-action-b
 import type { HTMLProps } from 'react';
 import type { EventHandler } from "@arcgis/lumina"; 
 
-interface ReactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, HTMLProps<HTMLArcgisChartElement> {
+interface ReactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableBetaFeatures' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, HTMLProps<HTMLArcgisChartElement> {
   onarcgisAxesMinMaxChange?: EventHandler<HTMLArcgisChartElement["arcgisAxesMinMaxChange"]>;
   onarcgisBadDataWarningRaise?: EventHandler<HTMLArcgisChartElement["arcgisBadDataWarningRaise"]>;
   onarcgisChartNotFoundWarning?: EventHandler<HTMLArcgisChartElement["arcgisChartNotFoundWarning"]>;

package/dist/types/stencil.d.ts

@@ -4,7 +4,7 @@ import type { ArcgisChartsActionBar } from "../components/arcgis-charts-action-b
 import { JSXBase as StencilJsx } from "@stencil/core/internal";
 import type { EventHandler } from "@arcgis/lumina";
 
-interface StencilArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, StencilJsx.HTMLAttributes<HTMLArcgisChartElement> {
+interface StencilArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDestroyDisabled' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableBetaFeatures' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'messageOverrides' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, StencilJsx.HTMLAttributes<HTMLArcgisChartElement> {
   onArcgisAxesMinMaxChange?: EventHandler<HTMLArcgisChartElement["arcgisAxesMinMaxChange"]>;
   onArcgisBadDataWarningRaise?: EventHandler<HTMLArcgisChartElement["arcgisBadDataWarningRaise"]>;
   onArcgisChartNotFoundWarning?: EventHandler<HTMLArcgisChartElement["arcgisChartNotFoundWarning"]>;

package/dist/utils/chart-config/converter/index.d.ts

@@ -1,7 +1,7 @@
 import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
+import { SupportedLayer } from '../../../interfaces';
 import { WebBoxPlot, WebChart, WebChartBoxPlotSeries, WebChartDirectionalDataOrder, WebChartLineChartSeries, WebGaugeChart, WebHeatChart, WebChartOrderDataByTypes } from '../../../spec';
 import { FormerWebChartBoxPlotDataSortTypes, FormerWebChartDataValueTypes } from './interfaces';
-import { SupportedLayer } from '../../../interfaces';
 /** ***********************************************************************************
  *                                                                                    *
  * Routines that handle adjustments/conversions for chart regardless of chart version.*
@@ -14,18 +14,17 @@ import { SupportedLayer } from '../../../interfaces';
  * @param chartContainer The chart's container
  */
 declare function applyDefaultFirstDayOfWeek(props: {
-    configToUpdate: WebChart | WebHeatChart;
+    configToUpdate: WebHeatChart;
     chartContainer?: HTMLElement;
     layer?: SupportedLayer;
-}): WebChart | WebHeatChart;
+}): WebHeatChart;
 declare function adjustAxes(configToUpdate: WebChart): WebChart;
 declare function adjustSeries(configToUpdate: WebChart): WebChart;
 /**
  * Matches the config properties that have field names which mismatch the layer data source fields.
  *
- * @param {*} config The chart config
- * @param {*} layer The layer instance
- * @returns {Promise<WebChart>}
+ * @param config - The chart config
+ * @param layer - The layer instance
  */
 declare function matchChartFieldsToLayerFields(configToUpdate: WebChart, layer?: SupportedLayer): Promise<WebChart>;
 /**
@@ -438,14 +437,12 @@ declare function applyConversions<T extends WebChart>(props: {
 /**
  * Main function that converts the chart config with older chart JSON Schema, comparing to the current version.
  *
- * Notes:
- * 1. This function will convert and update the chart config to the current version if the version is older or unrecognized.
- * 2. This function will also call mandatory conversion functions that are not related to the spec version
- * to ensure certain features are working properly.
- *
- * @param {*} config The chart config
- * @param {*} layer The layer instance
+ * **Note**:
+ *   1. This function will convert and update the chart config to the current version if the version is older or unrecognized.
+ *   2. This function will also call mandatory conversion functions that are not related to the spec version to ensure certain features are working properly.
  *
+ * @param config - The chart config
+ * @param layer - The layer instance
  * @returns the updated web chart config.
  */
 export declare function convertChartSpec<T extends WebChart | WebGaugeChart>(config?: T, layerOrLayerView?: FeatureLayerView | SupportedLayer, chartContainer?: HTMLElement): Promise<T>;

package/dist/utils/chart-config/utils/index.d.ts

@@ -1,5 +1,5 @@
 import { ChartOptions } from '../../../chart-rendering/common/interfaces';
-import { IField, TimeIntervalInfo, WebBoxPlot, WebChart, WebChartLegend, WebChartSeriesType, RESTSymbolType, WebChartTypes, WebChartVersionStatus } from '../../../spec';
+import { IField, TimeIntervalInfo, WebBoxPlot, WebChart, WebChartLegend, WebChartSeriesType, WebHeatChart, RESTSymbolType, WebChartTypes, WebChartVersionStatus } from '../../../spec';
 import { DataUpdateDetails } from '../../data/interfaces';
 import { LimitBehavior } from '../../defaults/interfaces';
 import { ChartSubType } from '../../misc/interfaces';
@@ -177,7 +177,7 @@ declare function isNewDataRequiredForValueFormatChange(previousConfig: WebBoxPlo
  * @param previousConfig The former chart config
  * @param newConfig The new chart config
  */
-declare function hasShowMeanChanged(previousConfig: WebBoxPlot | WebChart, newConfig: WebBoxPlot | WebChart): boolean;
+declare function hasShowMeanChanged(previousConfig: WebBoxPlot, newConfig: WebBoxPlot): boolean;
 /**
  * Compares two gauge configs and indicates whether the series value conversion changed
  *
@@ -191,22 +191,22 @@ declare function hasGaugeValueConversionChanged(previousConfig: WebChart, newCon
  * @param previousConfig The previous config
  * @param newConfig The updated config
  */
-declare function hasHeatChartBinningChanged(previousConfig: WebChart, newConfig: WebChart): boolean;
+declare function hasHeatChartBinningChanged(previousConfig: WebHeatChart, newConfig: WebHeatChart): boolean;
 /**
  * Compares two heat chart configs and indicates whether the hide empty rows and columns option changed
  *
  * @param previousConfig The previous config
  * @param newConfig The updated config
  */
-export declare function hasHeatChartHideEmptyRowsAndColumnsChanged(previousConfig: WebChart, newConfig: WebChart): boolean;
+export declare function hasHeatChartHideEmptyRowsAndColumnsChanged(previousConfig: WebHeatChart, newConfig: WebHeatChart): boolean;
 /**
- * Compares two configs and indicates whether additional tooltip fields (only non-numeric) changed
+ * Compares two configs and indicates whether additional tooltip fields (only non-numeric) changed.
  *
- * **NOTE**: (only for scatterplot)
+ * **NOTE**: Only applicable to scatterplot
  *
- * @param {WebChart} props.previousConfig The previous config
- * @param {WebChart} props.newConfig The updated config
- * @param {IField[]|undefined} props.fieldList The layer field list
+ * @param props.previousConfig - The previous config
+ * @param props.newConfig - The updated config
+ * @param props.fieldList - The layer field list
  */
 export declare function hasAdditionalTooltipFieldsChanged(props: {
     previousConfig: WebChart;
@@ -239,28 +239,28 @@ export declare function normalizeLegendPosition(legend: WebChartLegend): WebChar
  * @param oldConfig The previous config
  * @param newConfig The updated config
  */
-export declare function hasHeatLegendConfigChanged(oldConfig: WebChart, newConfig: WebChart): boolean;
+export declare function hasHeatLegendConfigChanged(oldConfig: WebHeatChart, newConfig: WebHeatChart): boolean;
 /**
  * Compates two configs and indicates whether the heat legend position changed
  *
  * @param oldConfig The previous config
  * @param newConfig The updated config
  */
-export declare function hasHeatLegendPositionChanged(oldConfig: WebChart, newConfig: WebChart): boolean;
+export declare function hasHeatLegendPositionChanged(oldConfig: WebHeatChart, newConfig: WebHeatChart): boolean;
 /**
  * Compares two configs and indicates whether the gradient rules changed
  *
  * @param oldConfig The previous config
  * @param newConfig The updated config
  */
-export declare function hasGradientRulesChanged(oldConfig: WebChart, newConfig: WebChart): boolean;
+export declare function hasGradientRulesChanged(oldConfig: WebHeatChart, newConfig: WebHeatChart): boolean;
 /**
  * Compares two configs and indicates whether the heat rules type changed
  *
  * @param oldConfig The previous config
  * @param newConfig The updated config
  */
-export declare function hasHeatRulesTypeChanged(oldConfig: WebChart, newConfig: WebChart): boolean;
+export declare function hasHeatRulesTypeChanged(oldConfig: WebHeatChart, newConfig: WebHeatChart): boolean;
 /**
  * Compares the 'slices' array from the pie series, and indicates whether they are different.
  * Compare only the slices id and label to avoid false positives.
@@ -332,14 +332,14 @@ export declare function hasRotationChanged(oldConfig: WebChart, newConfig: WebCh
  * @param oldConfig the old chart config
  * @param newConfig the new chart config
  */
-export declare function hasOutliersVisibilityChanged(oldConfig: WebChart, newConfig: WebChart): boolean;
+export declare function hasOutliersVisibilityChanged(oldConfig: WebBoxPlot, newConfig: WebBoxPlot): boolean;
 /**
  * Returns true if the 'standardizeValues' property changed in the chart config since the previous update.
  *
  * @param oldConfig the old chart config
  * @param newConfig the new chart config
  */
-export declare function hasStandardizeValuesVisibilityChanged(oldConfig: WebChart, newConfig: WebChart): boolean;
+export declare function hasStandardizeValuesVisibilityChanged(oldConfig: WebBoxPlot, newConfig: WebBoxPlot): boolean;
 /**
  * Returns true if the 'chartRenderer' property changed in the chart config since the previous update.
  *

package/dist/utils/components/action-bar-utils.d.ts

@@ -5,8 +5,8 @@ import { ChartTypes, DefaultChartActions } from '../../utils';
 /**
  * Returns the default actions for a given chart type
  *
- * @param {ChartTypes} chartType The chart type for which to get the default actions
- * @returns {DefaultChartActions[]} The default actions for the given chart type
+ * @param props.chartType - The chart type for which to get the default actions
+ * @returns The default actions for the given chart type
  */
 export declare function getDefaultChartActions(chartType: ChartTypes | undefined): DefaultChartActions[];
 /**
@@ -19,10 +19,10 @@ export declare const onActionBarSlotChange: (e: Event, chartComponent: HTMLArcgi
 /**
  * Updates the action bar states based on the properties of the chart component and the config object.
  *
- * @param {HTMLArcgisChartsActionBarElement} props.actionBar - The action bar element to update.
- * @param {HTMLArcgisChartElement} props.chartComponent - The chart component element.
- * @param {WebChart} [props.config] - The configuration object for the chart.
- * @param {boolean} [props.isWarningDisplayed] - Optional flag to indicate if a warning is displayed.
+ * @param props.actionBar - The action bar element to update.
+ * @param props.chartComponent - The chart component element.
+ * @param props.config - The configuration object for the chart.
+ * @param props.isWarningDisplayed - Optional flag to indicate if a warning is displayed.
  *
  */
 export declare function updateActionBarStates(props: {

package/dist/utils/components/chart-ui-utils.d.ts

@@ -85,30 +85,22 @@ export declare function sanitizeColor(color: RGB | undefined): RGB | null;
 /**
  * Handler for "keydown" event on numberic input element. Prevents input of "e" character.
  *
- * @param e Input element "keydown" event
+ * @param e - Input element "keydown" event
  */
 export declare const blockNumericE: (e: KeyboardEvent) => void;
 /**
- * emit numeric field change event
- *
- * @param props.pickListElement
- * @param props.eventEmitter
- * @param props.contentKind
- * @category Public
+ * Emit numeric field change event.
  */
 export declare const emitNumericFieldsChange: (props: NumericFieldsChangeProps) => void;
 /**
  * Returns the line style type based on the provided line style.
- *
- * @param lineStyle
  */
 export declare function getLineStyleType(lineStyle: RESTSimpleLineSymbolStyle | undefined): string;
 /**
  * Downloads an object as a file using a data URL.
  *
- * @param {string} objectURL - The data URL of the object to download.
- * @param {string} downloadString - The name of the file to download.
- * @category Public
+ * @param objectURL - The data URL of the object to download.
+ * @param downloadString - The name of the file to download.
  */
 export declare function downloadFile(objectURL: string, downloadString: string): void;
 /**

package/dist/utils/components/message-utils.d.ts

@@ -1,9 +1,8 @@
 import { WebChartTypes } from '../../spec';
 import { ErrorStrings } from '../localization/interfaces';
 /**
- * Pulls the proper placeholder according to the chart type
+ * Pulls the proper placeholder according to the chart type.
  *
- * @param chartType The chart type to get the placeholder for
- * @category Private
+ * @param chartType - The chart type to get the placeholder for
  */
 export declare function getChartPlaceholder(chartType?: WebChartTypes, errorStrings?: ErrorStrings): string | undefined;

package/dist/utils/components/web-component-utils.d.ts

@@ -6,23 +6,18 @@ import { SupportedLocalesForFormats } from '../localization/interfaces';
 import { ChartConfig } from '../types';
 /**
  * A utility function to compare if a value has changed deeply.
- * @param value
- * @param oldValue
  */
 export declare function hasChangedDeep<T>(value: T, oldValue?: T): boolean;
 /**
  * A utility function to compare if a value has changed deeply or shallowly.
- * @param value
- * @param oldValue
  */
 export declare function hasChangedDeepOrShallow<T>(value: T, oldValue?: T): boolean;
 /**
  * Formats a cell value for CSV output.
  * This function handles quoting and escaping of special characters.
- * @param {unknown} value - The value to format.
- * @param {boolean} [quoteAll] - Whether to quote all values.
- *                               If `true`, all values will be quoted.
- *                               If `false` or `undefined`, only values that contain special characters will be quoted.
+ *
+ * @param value - The value to format.
+ * @param quoteAll - Whether to quote all values. If `true`, all values will be quoted. If `false` or `undefined`, only values that contain special characters will be quoted.
  */
 export declare const formatCell: (props: {
     value: unknown;
@@ -31,6 +26,7 @@ export declare const formatCell: (props: {
 }) => string;
 /**
  * Converts an array of objects to a CSV string.
+ *
  * @param data - The data to convert.
  * @param options - Options for CSV conversion.
  * @returns The CSV string.
@@ -39,10 +35,11 @@ export declare function arrayToCSV<T extends Record<string, unknown>>(data: T[],
 /**
  * Transform the raw data to a format that is suitable for exporting to CSV.
  * This function is used to transform the data before it is passed to the CSV export function.
- * @param props.config - [Optional] The chart configuration that defines the chart type and data transformation.
+ *
+ * @param props.config - The chart configuration that defines the chart type and data transformation.
  * @param props.rawData - The raw data to be transformed, which is an array of objects.
- * @param props.layer - [Optional] The layer associated with the chart, used for additional data context.
- * @param props.fieldList - [Optional] The list of fields in the layer, used to determine field types and names.
+ * @param props.layer - The layer associated with the chart, used for additional data context.
+ * @param props.fieldList - The list of fields in the layer, used to determine field types and names.
  */
 export declare function transformChartData<T extends Record<string, unknown>>(props: {
     config?: ChartConfig;
@@ -52,12 +49,14 @@ export declare function transformChartData<T extends Record<string, unknown>>(pr
 }): T[];
 /**
  * Transform the histogram data to a format that is suitable for exporting to CSV.
+ *
  * @param config - The histogram model or config
  * @param rows - The raw data to be transformed.
  */
 export declare function transformHistogramData<T extends Record<string, unknown>>(config: ChartConfig<typeof ModelTypes.Histogram>, rows: T[]): T[];
 /**
  * Processes the chart data for bar and line charts.
+ *
  * @param props.config - The chart model.
  * @param props.rows - The raw data to be transformed.
  * @param props.layer - The layer associated with the chart.
@@ -70,6 +69,7 @@ export declare function transformBarLineChartData<T extends Record<string, unkno
 }): T[];
 /**
  * Transform the pie chart data to a format that is suitable for exporting to CSV.
+ *
  * @param props.model - The pie chart model.
  * @param props.rows - The raw data to be transformed.
  * @param props.layer - The layer associated with the chart.
@@ -82,6 +82,7 @@ export declare function transformPieChartData<T extends Record<string, unknown>>
 }): T[];
 /**
  * Transform the box plot data to a format that is suitable for exporting to CSV.
+ *
  * @param model - The box plot model.
  * @param rows - The raw data to be transformed.
  * @returns The transformed data.
@@ -94,11 +95,14 @@ export declare function transformBoxPlotData<T extends Record<string, unknown>>(
 }): T[];
 /**
  * Check if the provided date is valid.
- * @param {unknown} date - The date to check, should be a string or a number.
+ *
+ * @param date - The date to check, should be a string or a number.
  */
 export declare const isValidDate: (date: unknown) => date is Date | number | string;
 /**
  * Returns a unique ID.
- * Example: 33c2c20e-5a9e-c7be-1b23-b210e6218831
+ *
+ * @example
+ * 33c2c20e-5a9e-c7be-1b23-b210e6218831
  */
 export declare function generateGUID(): string;

package/dist/utils/data/index.d.ts

@@ -11,30 +11,32 @@ export declare function getBoxPlotStatisticFieldNames(y?: string): Record<BoxPlo
  * Check the `subType` in the chart config to determine whether the chart is a gauge by feature.
  * If `subType` is not defined, the chart is defaulted to be a statistic gauge.
  *
- * @param config the chart config
- * @default false
+ * @param config - the chart config
  */
 export declare function isGaugeByFeature(config: WebChart): boolean;
 /**
  * From fetched data (type: WebChartDataTypes) returns the part containing the data that
  * is to be assigned to the chart (WebChartDataItem[] | WebChartBin[])
- * @param props.fetchedData The fetched finished data
+ *
+ * @param props.fetchedData - The fetched finished data
  */
 export declare function extractChartDataFromFetchedData(fetchedData?: WebChartDataTypes): WebChartBin[] | WebChartDataItem[] | undefined;
 /**
  * Determine whether the current box plot has multi-fields or not based on its query type
- * @param chartSubType: Box plot sub type
+ *
+ * @param chartSubType - Box plot sub type
  */
 export declare function isMultiFieldsBoxPlot(chartSubType?: ChartSubType): boolean;
 /**
  * Compute Y value for given Box Plot Y field key based on the provided config
- * @param props.key The BoxPlotYFieldKeys related to the stat
- * @param props.y The y field to use to get the y value
- * @param props.chartSubType The box plot sub type
- * @param props.splitBy The where clause used as a split-by value for a given series
- * @param props.splitByValue The split-by value for a given series
- * @param props.showOutliers Whether to show the outliers
- * @param props.standardizeValues Whether to show the standardized values
+ *
+ * @param props.key - The BoxPlotYFieldKeys related to the stat
+ * @param props.y - The y field to use to get the y value
+ * @param props.chartSubType - The box plot sub type
+ * @param props.splitBy - The where clause used as a split-by value for a given series
+ * @param props.splitByValue - The split-by value for a given series
+ * @param props.showOutliers - Whether to show the outliers
+ * @param props.standardizeValues - Whether to show the standardized values
  */
 export declare function getBoxPlotYValue(props: BoxPlotYValueProps): string;
 /**

package/dist/utils/defaults/index.d.ts

@@ -1,4 +1,4 @@
-import { CategoryFormatOptions, Color, DateTimeFormatOptions, HistogramOverlays, IFont, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, NumberFormatOptions, ScatterplotOverlays, SizePolicy, WebBoxPlot, WebChart, WebChartAxis, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartCursorCrosshair, WebChartGaugeAxis, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLegend, WebChartLineChartSeries, WebChartNeedle, WebChartOverlay, WebChartPieChartSeries, WebChartPieChartTick, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartText, WebChartTextSymbol, WebGaugeChart, WebChartStackedKinds, WebChartTypes } from '../../spec';
+import { CategoryFormatOptions, Color, DateTimeFormatOptions, HistogramOverlays, IFont, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, NumberFormatOptions, ScatterplotOverlays, SizePolicy, WebBoxPlot, WebChart, WebChartAxis, WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartCursorCrosshair, WebChartGaugeAxis, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLegend, WebChartLineChartSeries, WebChartNeedle, WebChartOverlay, WebChartPieChartSeries, WebChartPieChartTick, WebChartRadarChartSeries, WebChartScatterplotSeries, WebChartText, WebChartTextSymbol, WebGaugeChart, WebHeatChart, WebChartStackedKinds, WebChartTypes } from '../../spec';
 import { CommonStrings } from '../localization/interfaces';
 import { ChartElementLimit, ChartElementTechnicalLimit, ChartTextProps, QueryDefaults, TextElements } from './interfaces';
 export declare const histogramBinCount = 32;
@@ -170,9 +170,9 @@ export declare function getDefaultScatterplot(commonStrings: CommonStrings, id?:
  * Gets default heat chart
  * @param commonStrings
  * @param id
- * @returns WebChart
+ * @returns WebHeatChart
  */
-export declare function getDefaultHeatChart(commonStrings: CommonStrings, objectIDField: string): WebChart;
+export declare function getDefaultHeatChart(commonStrings: CommonStrings, objectIDField: string): WebHeatChart;
 export declare function getDefaultHistogramOverlays(): Required<HistogramOverlays>;
 export declare function getDefaultHistogramSymbol(): ISimpleFillSymbol;
 export declare function getDefaultHistogramSeries(): Omit<Required<WebChartHistogramSeries>, "dataTooltipDateFormat" | "dataTooltipPercentFormat" | "dataTooltipValueFormat" | "query">;

package/dist/utils/errors/index.d.ts

@@ -17,11 +17,11 @@ export declare class ArcgisChartsError<T = any> extends Error {
      */
     details?: T;
     /**
-     * Creates a new ArcgisChartsError instance.
+     * Creates a new `ArcgisChartsError` instance.
      *
-     * @param {string} name - A unique error name.
-     * @param {string} [message] - A message describing the details of the error.
-     * @param {Object} [details] - The details object provides additional details specific to the error.
+     * @param name - A unique error name.
+     * @param message - A message describing the details of the error.
+     * @param details - The details object provides additional details specific to the error.
      */
     constructor(name: string, message?: string, details?: T);
 }