@arcgis/charts-components 5.1.0-next.13 → 5.1.0-next.130

package/dist/loader.js

@@ -1,17 +1,17 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
 import { r as e } from "./chunks/runtime.js";
 import { makeDefineCustomElements as t } from "@arcgis/lumina";
-const o = t(e, {
-  "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "_messages:,actionMode,allowUsingObjectIdStat,aria:,autoDestroyDisabled,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,commonStrings:,cursorRange,dataLabelFormatter:,disableAutoTheming,disableInteractions,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:;clearSelection,errorAlert,exportAsCSV,exportAsImage,loadModel,notify,refresh,resetZoom,switchSelection"],
-  "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "_messages:,actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,commonStrings:,disableCSVExportForChartTypes:,editChartState,editChartTitle,editChartToggle,expanded,exportActionState,exportAsCSVState,exportAsCSVTitle,exportAsImageState,exportAsImageTitle,filterByExtentState,filterByExtentTitle,filterByExtentToggle,filterBySelectionState,filterBySelectionTitle,filterBySelectionToggle,forceDisableActions,fullExtentState,fullExtentTitle,fullExtentToggle,hiddenActions:,legendState,legendTitle,legendToggle,messageOverrides:,rotateChartState,rotateChartTitle,rotateChartToggle,selectionState,selectionTitle,selectionToggle,switchSelectionState,switchSelectionTitle,switchSelectionToggle,zoomState,zoomTitle,zoomToggle"],
+const r = t(e, {
+  "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "_messages:,actionMode,allowUsingObjectIdStat,animationEnabled,aria:,autoDestroyDisabled,autoDisposeChart,autoInverseDataLabelTextColor,calciteThemingCSSVariables:,chartIndex,chartLimits:,chartWillRender:,commonStrings:,configurationEnabled,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableBetaFeatures,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,filterByViewExtent,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,hideUIMessages,hideZeroCountCategories,ignoreSmoothRenderingLimit,ignoreViewExtent,interactionsDisabled,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerItemId,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,loaderColors:,messageOverrides:,model:,nullAsValid,placeholder,popupTemplateFieldInfosEnabled,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotated,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionManager:,selectionTheme:,setTimeBinningInfoWhenNotProvided,showEmptySeries,showLicenseWatermark,showUIMessages,skipChartCreationQueue,syncChartsSelection,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,syncViewSelection,syncViewTimeExtent,syncViewTimeZone,syncViewTimeZoneInclusionList:,timeZone,togglingLegendItemsDisabled,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,destroy,errorAlert,exportAsCSV,exportAsImage,loadModel,notify,refresh,resetZoom,switchSelection;applySelectionFromSelectionManager"],
+  "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "_messages:,actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,commonStrings:,csvExportExclusionList:,disableCSVExportForChartTypes:,editChartState,editChartTitle,editChartToggle,expanded,exportActionState,exportAsCSVState,exportAsCSVTitle,exportAsImageState,exportAsImageTitle,filterByExtentState,filterByExtentTitle,filterByExtentToggle,filterBySelectionState,filterBySelectionTitle,filterBySelectionToggle,forceDisableActions,fullExtentState,fullExtentTitle,fullExtentToggle,hiddenActions:,legendState,legendTitle,legendToggle,messageOverrides:,rotateChartState,rotateChartTitle,rotateChartToggle,selectionState,selectionTitle,selectionToggle,switchSelectionState,switchSelectionTitle,switchSelectionToggle,zoomState,zoomTitle,zoomToggle"],
   "arcgis-charts-config-axes": [() => import("./components/arcgis-charts-config-axes/customElement.js"), "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,messageOverrides:,model:,open,showEnableXLogOption,showEnableYLogOption,showMaxXBoundOption,showMaxYBoundOption,showMinXBoundOption,showMinYBoundOption"],
   "arcgis-charts-config-axis": [() => import("./components/arcgis-charts-config-axis/customElement.js"), "axisTitle,dataMaxValue,dataMinValue,initialMaxBound,initialMinBound,isXAxis,maxBoundMaxLimit,maxBoundMinLimit,messageOverrides:,minBoundMaxLimit,minBoundMinLimit,model:,showEnableLogOption,showMaxBoundOption,showMinBoundOption"],
-  "arcgis-charts-config-bar-chart": [() => import("./components/arcgis-charts-config-bar-chart/customElement.js"), "calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,seriesColor:,timeZone,usePopupTemplateFieldsInfo"],
+  "arcgis-charts-config-bar-chart": [() => import("./components/arcgis-charts-config-bar-chart/customElement.js"), "calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,popupTemplateFieldInfosEnabled,seriesColor:,timeZone,usePopupTemplateFieldsInfo"],
   "arcgis-charts-config-bar-chart-data": [() => import("./components/arcgis-charts-config-bar-chart-data/customElement.js"), "layerFieldsInfo:,messageOverrides:,model:,open"],
   "arcgis-charts-config-bar-chart-popover": [() => import("./components/arcgis-charts-config-bar-chart-popover/customElement.js"), "contentKind,headingTitle,isCustomSortDisabled,isNoAggregationDisabled,layerFieldsInfo:,messageOverrides:,open,referenceElement:,selectedContent;reposition"],
   "arcgis-charts-config-bar-chart-series": [() => import("./components/arcgis-charts-config-bar-chart-series/customElement.js"), "activeColorMatch,messageOverrides:,model:,popoverPlacement"],
   "arcgis-charts-config-bar-chart-series-popover": [() => import("./components/arcgis-charts-config-bar-chart-series-popover/customElement.js"), "messageOverrides:,nullCategory:,open,placement,referenceElement:,selectedColor:,selectedName,selectedSeriesIndex;reposition"],
-  "arcgis-charts-config-box-plot": [() => import("./components/arcgis-charts-config-box-plot/customElement.js"), "calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,seriesColor:,usePopupTemplateFieldsInfo"],
+  "arcgis-charts-config-box-plot": [() => import("./components/arcgis-charts-config-box-plot/customElement.js"), "calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,popupTemplateFieldInfosEnabled,seriesColor:,usePopupTemplateFieldsInfo"],
   "arcgis-charts-config-box-plot-data": [() => import("./components/arcgis-charts-config-box-plot-data/customElement.js"), "layerFieldsInfo:,messageOverrides:,model:"],
   "arcgis-charts-config-box-plot-popover": [() => import("./components/arcgis-charts-config-box-plot-popover/customElement.js"), "contentKind,headingTitle,isCustomSortDisabled,layerFieldsInfo:,messageOverrides:,open,referenceElement:,selectedContent;reposition"],
   "arcgis-charts-config-box-plot-series": [() => import("./components/arcgis-charts-config-box-plot-series/customElement.js"), "activeColorMatch,configSeriesOpen,messageOverrides:,model:,popoverPlacement"],
@@ -20,7 +20,7 @@ const o = t(e, {
   "arcgis-charts-config-chart-rename-popover": [() => import("./components/arcgis-charts-config-chart-rename-popover/customElement.js"), "messageOverrides:,name,open,referenceElement:;reposition"],
   "arcgis-charts-config-color-style": [() => import("./components/arcgis-charts-config-color-style/customElement.js"), "enableClose,header,messageOverrides:,open,selectedColor:"],
   "arcgis-charts-config-colors": [() => import("./components/arcgis-charts-config-colors/customElement.js"), "heading,messageOverrides:,rgba:"],
-  "arcgis-charts-config-create-flow": [() => import("./components/arcgis-charts-config-create-flow/customElement.js"), "activeLayerId,calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,chartData:,disableEditing,filterBySelection,headerTitle,layerList:,messageOverrides:,modelList:,open,panelNumber,popoverPlacement,r2,selectedChartId,seriesColor:,syncChartsToLayers,timeZone,usePopupTemplateFieldsInfo;setFocus"],
+  "arcgis-charts-config-create-flow": [() => import("./components/arcgis-charts-config-create-flow/customElement.js"), "activeLayerId,calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,chartData:,close,disableEditing,filterBySelection,headerTitle,layerList:,messageOverrides:,modelList:,panelNumber,popoverPlacement,popupTemplateFieldInfosEnabled,r2,selectedChartId,seriesColor:,syncChartsToLayers,timeZone,usePopupTemplateFieldsInfo;setFocus"],
   "arcgis-charts-config-field-select": [() => import("./components/arcgis-charts-config-field-select/customElement.js"), "disabled,invalid,label"],
   "arcgis-charts-config-font-style": [() => import("./components/arcgis-charts-config-font-style/customElement.js"), "enableClose,fontStyle:,header,messageOverrides:,open"],
   "arcgis-charts-config-format": [() => import("./components/arcgis-charts-config-format/customElement.js"), "messageOverrides:,model:"],
@@ -30,32 +30,32 @@ const o = t(e, {
   "arcgis-charts-config-guide-popover": [() => import("./components/arcgis-charts-config-guide-popover/customElement.js"), "messageOverrides:,open,placement,referenceElement:,selectedElement:;reposition"],
   "arcgis-charts-config-guides": [() => import("./components/arcgis-charts-config-guides/customElement.js"), "calculatedMinMaxBounds:,enableXAxisGuide,enableYAxisGuide,messageOverrides:,model:,open,timeZone"],
   "arcgis-charts-config-guides-type-popover": [() => import("./components/arcgis-charts-config-guides-type-popover/customElement.js"), "enableXAxisGuide,enableYAxisGuide,messageOverrides:,open,placement,referenceElement:;reposition"],
-  "arcgis-charts-config-heat-chart": [() => import("./components/arcgis-charts-config-heat-chart/customElement.js"), "chartData:,layer:,model:,page,usePopupTemplateFieldsInfo"],
-  "arcgis-charts-config-heat-chart-data": [() => import("./components/arcgis-charts-config-heat-chart-data/customElement.js"), "chartData:,layerFieldsInfo:,messageOverrides:,model:,open"],
+  "arcgis-charts-config-heat-chart": [() => import("./components/arcgis-charts-config-heat-chart/customElement.js"), "layer:,model:,page,popupTemplateFieldInfosEnabled,usePopupTemplateFieldsInfo"],
+  "arcgis-charts-config-heat-chart-data": [() => import("./components/arcgis-charts-config-heat-chart-data/customElement.js"), "layerFieldsInfo:,messageOverrides:,model:,open"],
   "arcgis-charts-config-heat-chart-popover": [() => import("./components/arcgis-charts-config-heat-chart-popover/customElement.js"), "colorRamps:,contentKind,headingTitle,isFlipped,layerFieldsInfo:,messageOverrides:,model:,open,referenceElement:,selectedContent;reposition"],
-  "arcgis-charts-config-histogram": [() => import("./components/arcgis-charts-config-histogram/customElement.js"), "calculatedMinMaxBounds:,chartData:,layer:,model:,page,seriesColor:,usePopupTemplateFieldsInfo"],
+  "arcgis-charts-config-histogram": [() => import("./components/arcgis-charts-config-histogram/customElement.js"), "calculatedMinMaxBounds:,chartData:,layer:,model:,page,popupTemplateFieldInfosEnabled,seriesColor:,usePopupTemplateFieldsInfo"],
   "arcgis-charts-config-histogram-data": [() => import("./components/arcgis-charts-config-histogram-data/customElement.js"), "countValue,layerFieldsInfo:,maxValue,meanValue,medianValue,messageOverrides:,minValue,model:,nullsValue,open,selectedOverlaySymbolType,standardDevValue,sumValue"],
   "arcgis-charts-config-histogram-popover": [() => import("./components/arcgis-charts-config-histogram-popover/customElement.js"), "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,placement,referenceElement:,selectedBinColor:,selectedNumericField,selectedOverlaySymbol:,selectedOverlaySymbolType,selectedTransformationType;reposition"],
   "arcgis-charts-config-invalid-input-message": [() => import("./components/arcgis-charts-config-invalid-input-message/customElement.js"), "invalidInputMessage,isInvalid"],
-  "arcgis-charts-config-line-chart": [() => import("./components/arcgis-charts-config-line-chart/customElement.js"), "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,seriesColor:,timeZone,usePopupTemplateFieldsInfo"],
+  "arcgis-charts-config-line-chart": [() => import("./components/arcgis-charts-config-line-chart/customElement.js"), "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,popupTemplateFieldInfosEnabled,seriesColor:,timeZone,usePopupTemplateFieldsInfo"],
   "arcgis-charts-config-line-chart-data": [() => import("./components/arcgis-charts-config-line-chart-data/customElement.js"), "layerFieldsInfo:,messageOverrides:,model:,resetTimeInterval:"],
   "arcgis-charts-config-line-chart-popover": [() => import("./components/arcgis-charts-config-line-chart-popover/customElement.js"), "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,referenceElement:,selectedContent;reposition"],
   "arcgis-charts-config-line-chart-series": [() => import("./components/arcgis-charts-config-line-chart-series/customElement.js"), "activeColorMatch,messageOverrides:,model:,popoverPlacement"],
   "arcgis-charts-config-line-chart-series-popover": [() => import("./components/arcgis-charts-config-line-chart-series-popover/customElement.js"), "messageOverrides:,open,placement,referenceElement:,selectedColor:,selectedLineStyle,selectedLineWidth,selectedName,selectedSeriesIndex;reposition"],
   "arcgis-charts-config-line-style": [() => import("./components/arcgis-charts-config-line-style/customElement.js"), "enableClose,header,lineStyle:,messageOverrides:,open,usePanel"],
   "arcgis-charts-config-number-format": [() => import("./components/arcgis-charts-config-number-format/customElement.js"), "messageOverrides:,numberFormat:"],
-  "arcgis-charts-config-pie-chart": [() => import("./components/arcgis-charts-config-pie-chart/customElement.js"), "calculatedMinMaxBounds:,chartData:,filterBySelection,layer:,model:,page,popoverPlacement,seriesColor:,usePopupTemplateFieldsInfo"],
+  "arcgis-charts-config-pie-chart": [() => import("./components/arcgis-charts-config-pie-chart/customElement.js"), "calculatedMinMaxBounds:,chartData:,filterBySelection,layer:,model:,page,popoverPlacement,popupTemplateFieldInfosEnabled,seriesColor:,usePopupTemplateFieldsInfo"],
   "arcgis-charts-config-pie-chart-data": [() => import("./components/arcgis-charts-config-pie-chart-data/customElement.js"), "layerFieldsInfo:,messageOverrides:,model:"],
   "arcgis-charts-config-pie-chart-popover": [() => import("./components/arcgis-charts-config-pie-chart-popover/customElement.js"), "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,referenceElement:,selectedContent;reposition"],
   "arcgis-charts-config-pie-chart-slices": [() => import("./components/arcgis-charts-config-pie-chart-slices/customElement.js"), "chartData:,messageOverrides:,model:,popoverPlacement"],
   "arcgis-charts-config-pie-chart-slices-popover": [() => import("./components/arcgis-charts-config-pie-chart-slices-popover/customElement.js"), "messageOverrides:,open,placement,referenceElement:,selectedColor:,selectedName,selectedSliceId;reposition"],
-  "arcgis-charts-config-scatter-plot": [() => import("./components/arcgis-charts-config-scatter-plot/customElement.js"), "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,r2,usePopupTemplateFieldsInfo"],
+  "arcgis-charts-config-scatter-plot": [() => import("./components/arcgis-charts-config-scatter-plot/customElement.js"), "calculatedDataMinMaxBounds:,calculatedMinMaxBounds:,layer:,model:,page,popoverPlacement,popupTemplateFieldInfosEnabled,r2,usePopupTemplateFieldsInfo"],
   "arcgis-charts-config-scatter-plot-data": [() => import("./components/arcgis-charts-config-scatter-plot-data/customElement.js"), "isTableLayer,layerFieldsInfo:,messageOverrides:,model:,r2"],
   "arcgis-charts-config-scatter-plot-popover": [() => import("./components/arcgis-charts-config-scatter-plot-popover/customElement.js"), "contentKind,headingTitle,layerFieldsInfo:,messageOverrides:,open,placement,referenceElement:,selectedContent;reposition"],
-  "arcgis-charts-config-select-chart-type-popover": [() => import("./components/arcgis-charts-config-select-chart-type-popover/customElement.js"), "headerTitle,layerId,messageOverrides:,open,popoverPlacement,referenceElement:,selectedModelType;reposition"],
+  "arcgis-charts-config-select-chart-type-popover": [() => import("./components/arcgis-charts-config-select-chart-type-popover/customElement.js"), "headerTitle,isRasterBarChartSupported,layerId,layerType,messageOverrides:,open,popoverPlacement,referenceElement:,selectedModelType;reposition"],
   "arcgis-charts-config-view-charts": [() => import("./components/arcgis-charts-config-view-charts/customElement.js"), "disableEditing,layer:,messageOverrides:,modelList:,noGroup,selectedChartId"],
-  "arcgis-charts-info-modal": [() => import("./components/arcgis-charts-info-modal/customElement.js"), "calciteThemeApplied,heading,loaderColors:,message,showErrorModalInfo,showLoader"]
+  "arcgis-charts-info-modal": [() => import("./components/arcgis-charts-info-modal/customElement.js"), "calciteThemeColors:,heading,loaderColors:,message,showLoader"]
 });
 export {
-  o as defineCustomElements
+  r as defineCustomElements
 };

package/dist/model/bar-chart-model/bar-chart-model.d.ts

@@ -5,13 +5,15 @@ import type { ChartConfig } from "../../utils/types/index.js";
 
 export class BarChartModel extends SerialChartModel {
   /**
-   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets whether to hide oversized data labels of the side-by-side series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
   /**
-   * Gets whether to hide oversized stacked labels of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets whether to hide oversized stacked labels of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
@@ -44,7 +46,6 @@ export class BarChartModel extends SerialChartModel {
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.BarChart>>): Promise<void>;
 }

package/dist/model/box-plot-model/box-plot-model.d.ts

@@ -1,42 +1,46 @@
+import type { RESTSimpleLineSymbolStyle } from "../../spec/rest-js-object-literals.js";
+import type { Color } from "../../spec/rest-js-types.js";
+import type { WebChartDataFilters } from "../../spec/web-chart.js";
+import type { ChartConfig } from "../../utils/types/index.js";
 import type { ChartModel } from "../chart-model/chart-model.js";
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { ModelTypes, BoxPlotDataSortingKinds } from "../interfaces/common.js";
+import type { ModelWithLegend } from "../mixins/model-with-legend.js";
+import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
+import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
+import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
 import type { WithAxisLabelsSymbol } from "../properties/axes/axis-labels-symbol.js";
 import type { WithAxisLinesSymbol } from "../properties/axes/axis-lines-symbol.js";
-import type { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
+import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
 import type { WithXAxisLabelsVisibility } from "../properties/axes/x-axis/x-axis-labels-visibility.js";
 import type { WithXAxisTitleSymbol } from "../properties/axes/x-axis/x-axis-title-symbol.js";
 import type { WithXAxisTitleText } from "../properties/axes/x-axis/x-axis-title-text.js";
 import type { WithXAxisTitleVisibility } from "../properties/axes/x-axis/x-axis-title-visibility.js";
-import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
+import type { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
 import type { WithColorMatch } from "../properties/color-match.js";
-import type { WithRotatedState } from "../properties/rotated-state.js";
-import type { WithDataLabelsVisibility } from "../properties/data-labels/data-labels-visibility.js";
 import type { WithDataLabelsSymbol } from "../properties/data-labels/data-labels-symbol.js";
-import type { WebChartDataFilters } from "../../spec/web-chart.js";
-import type { Color } from "../../spec/rest-js-types.js";
-import type { RESTSimpleLineSymbolStyle } from "../../spec/rest-js-object-literals.js";
-import type { ChartConfig } from "../../utils/types/index.js";
-import type { ModelWithMultiAxes } from "../mixins/model-with-multi-axes.js";
-import type { ModelWithLegend } from "../mixins/model-with-legend.js";
-import type { ModelWithTooltips } from "../mixins/model-with-tooltips.js";
-import type { ModelWithYGuides } from "../mixins/model-with-y-guides.js";
+import type { WithDataLabelsVisibility } from "../properties/data-labels/data-labels-visibility.js";
+import type { WithRotatedState } from "../properties/rotated-state.js";
 
 export class BoxPlotModel extends BoxPlotModelSuperclass {
   /**
    * The index of the box plot series in the series array in config object when show mean is true.
    *
-   * **Note**: There is only one box plot series when show mean is true. The function returns '-1' if show mean is false.
+   * **Note**: There is only one box plot series when show mean is `true`. The function returns `-1` if show mean is `false`.
    */
   get boxPlotSeriesIndexWhenMeanLinesShown(): number;
   /** The category field for the box plot. */
   accessor category: string;
-  /** The color of the boxes when showing mean lines. Only applicable when mean lines are shown. */
+  /**
+   * The color of the boxes when showing mean lines.
+   *
+   * Only applicable when mean lines are shown.
+   */
   accessor meanLinesBoxColor: Color | undefined;
   /** The numeric fields array for the box plot. */
   get numericFields(): string[];
   set numericFields(value: string[] | string);
-  /** The list of category's values for custom sort */
+  /** The list of category values for custom sort. */
   accessor orderByList: string[];
   /** The order of the series array by returning an array of series ids. */
   accessor orderOfSeries: string[];
@@ -107,9 +111,15 @@ export class BoxPlotModel extends BoxPlotModelSuperclass {
   /** Resets the series styling to the default styling. */
   resetSeriesStyling(): void;
   /**
-   * Sets the data filter for the bar chart.
+   * Sets the data filter for the box plot.
    *
    * @param newDataFilter - The new data filter.
+   * @example
+   * ```typescript
+   * chartModel.setDataFilters({
+   *    where: "population > 100000",
+   * });
+   * ```
    */
   setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
   /**
@@ -117,6 +127,10 @@ export class BoxPlotModel extends BoxPlotModelSuperclass {
    *
    * @param newColor - The new color for the series.
    * @param seriesIndex - The index of the series.
+   * @example
+   * ```typescript
+   * chartModel.setSeriesColor([100, 100, 100, 255], 1);
+   * ```
    */
   setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
   /**
@@ -155,14 +169,9 @@ export class BoxPlotModel extends BoxPlotModelSuperclass {
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.BoxPlot>>): Promise<void>;
-  /**
-   * Updates the series based on the layer filter.
-   *
-   * @async **This method is `async` and must be awaited for the changes to take effect.*
-   */
+  /** Updates the series based on the layer filter. */
   updateSeriesFromLayerFilter(): Promise<void>;
 }
 declare const BoxPlotModelSuperclass: typeof ChartModel & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithYGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithRotatedState & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

package/dist/model/chart-model/chart-model-base.d.ts

@@ -1,7 +1,7 @@
+import type { ChartTypes } from "../../utils/misc/index.js";
+import type { ChartConfig } from "../../utils/types/index.js";
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { ChartModel } from "./chart-model.js";
-import type { ChartConfig } from "../../utils/types/index.js";
-import type { ChartTypes } from "../../utils/misc/index.js";
 
 export abstract class ChartModelBase extends EventTarget {
   constructor(...args: any[]);
@@ -27,7 +27,6 @@ export abstract class ChartModelBase extends EventTarget {
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params - The parameters to be used to set up the chart model.
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   abstract setup(params: ModelParams<ChartConfig>): Promise<void>;
   /** Can be awaited to allow any pending async updates to complete. */

package/dist/model/chart-model/chart-model.d.ts

@@ -19,10 +19,11 @@ import type { WithSeriesId } from "../properties/series/series-id.js";
 import type { WithSeriesIndex } from "../properties/series/series-index.js";
 import type { WithSeriesLength } from "../properties/series/series-length.js";
 import type { WithChartSubType } from "../properties/chart-sub-type.js";
+import type { WithSeriesDataTooltipFontSize } from "../properties/data-tooltip-font-size.js";
 import type { WithSeriesDataTooltipValueFormat } from "../properties/data-tooltip-value-format.js";
 import type { WithFetchNULLValues } from "../properties/fetch-null-values.js";
 import type { WithSplitByValues } from "../properties/split-by-values.js";
 import type { WithDataFilters } from "../properties/data-filters.js";
 
 export abstract class ChartModel extends ChartModelSuperclass {}
-declare const ChartModelSuperclass: typeof ChartModelBase & typeof WithDataFilters & typeof WithSplitByValues & typeof WithFetchNULLValues & typeof WithSeriesDataTooltipValueFormat & typeof WithChartSubType & typeof WithSeriesLength & typeof WithSeriesIndex & typeof WithSeriesId & typeof WithSeriesVisibility & typeof WithBackgroundColor & typeof WithChartRenderer & typeof WithDescriptionVisibility & typeof WithChartSubtitleVisibility & typeof WithChartTitleVisibility & typeof WithDescriptionSymbol & typeof WithDescriptionText & typeof WithSubtitleSymbol & typeof WithSubtitleText & typeof WithVersion & typeof WithTitleSymbol & typeof WithTitleText & typeof WithChartId & typeof WithLayer & typeof WithConfig
+declare const ChartModelSuperclass: typeof ChartModelBase & typeof WithDataFilters & typeof WithSplitByValues & typeof WithFetchNULLValues & typeof WithSeriesDataTooltipFontSize & typeof WithSeriesDataTooltipValueFormat & typeof WithChartSubType & typeof WithSeriesLength & typeof WithSeriesIndex & typeof WithSeriesId & typeof WithSeriesVisibility & typeof WithBackgroundColor & typeof WithChartRenderer & typeof WithDescriptionVisibility & typeof WithChartSubtitleVisibility & typeof WithChartTitleVisibility & typeof WithDescriptionSymbol & typeof WithDescriptionText & typeof WithSubtitleSymbol & typeof WithSubtitleText & typeof WithVersion & typeof WithTitleSymbol & typeof WithTitleText & typeof WithChartId & typeof WithLayer & typeof WithConfig

package/dist/model/combo-bar-line-chart-model/combo-bar-line-chart-model.d.ts

@@ -9,56 +9,64 @@ import type { ChartConfig } from "../../utils/types/index.js";
 
 export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
   /**
-   * Specify the color of the filled area for line chart.
+   * Gets the color of the filled area for line chart.
    * **Note:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
    *
    * @param seriesIndex - The index of the series.
    */
   getAreaColor(seriesIndex: number): Color | undefined;
   /**
-   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. '
+   *
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
   /**
-   * Gets whether to hide oversized data labels of the stacked series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets whether to hide oversized data labels of the stacked series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
   /**
-   * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the line style of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
   /**
-   * Gets the line width of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the line width of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesLineWidth(seriesIndex: number): number | undefined;
   /**
-   * Gets the marker color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the marker color of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesMarkerColor(seriesIndex: number): Color | undefined;
   /**
-   * Gets the marker size of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the marker size of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesMarkerSize(seriesIndex: number): number | undefined;
   /**
-   * Gets the marker style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
+   * Gets the marker style of the series based on the series index.
+   * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
    */
   getSeriesMarkerStyle(seriesIndex: number): RESTSimpleMarkerSymbolStyle | undefined;
   /**
-   * Specify whether the line series should show area.
+   * Indicate whether the area is visible for the line series.
    *
    * @param seriesIndex - The index of the series.
    */
@@ -84,7 +92,7 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    */
   setAreaColor(color: Color | undefined, seriesIndex: number): void;
   /**
-   * Specify whether the line series should show area.
+   * Specify whether the area should be visible for the line series.
    * **Note:** This method will only work if the series is a line chart series.
    *
    * @param visible - `true` if the line series should show area, `false` otherwise.
@@ -175,7 +183,6 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.ComboBarLineChart>>): Promise<void>;
 }

package/dist/model/gauge-model/gauge-model.d.ts

@@ -1,19 +1,19 @@
+import type { GaugeChartSubTypes, WebChartStatisticType } from "../../spec/chart-object-literals.js";
+import type { ISimpleFillSymbol } from "../../spec/rest-js-types.js";
+import type { ValueConversion, WebChartGaugeFixedProgressBands, WebChartTextSymbol } from "../../spec/web-chart.js";
+import type { ChartConfig } from "../../utils/types/index.js";
 import type { ChartModel } from "../chart-model/chart-model.js";
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { ModelTypes } from "../interfaces/common.js";
+import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
 import type { WithAxisLabelsSymbol } from "../properties/axes/axis-labels-symbol.js";
 import type { WithAxisLinesSymbol } from "../properties/axes/axis-lines-symbol.js";
-import type { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
+import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
 import type { WithXAxisLabelsVisibility } from "../properties/axes/x-axis/x-axis-labels-visibility.js";
 import type { WithXAxisTitleSymbol } from "../properties/axes/x-axis/x-axis-title-symbol.js";
 import type { WithXAxisTitleText } from "../properties/axes/x-axis/x-axis-title-text.js";
 import type { WithXAxisTitleVisibility } from "../properties/axes/x-axis/x-axis-title-visibility.js";
-import type { WithGenerateXAxisTitle } from "../properties/axes/x-axis/generate-x-axis-title.js";
-import type { ValueConversion, WebChartTextSymbol } from "../../spec/web-chart.js";
-import type { GaugeChartSubTypes, WebChartStatisticType } from "../../spec/chart-object-literals.js";
-import type { ISimpleFillSymbol } from "../../spec/rest-js-types.js";
-import type { ChartConfig } from "../../utils/types/index.js";
-import type { ModelWithXGuides } from "../mixins/model-with-x-guides.js";
+import type { WithXBounds } from "../properties/axes/x-axis/x-bounds.js";
 
 export class GaugeModel extends GaugeModelSuperclass {
   /**
@@ -28,20 +28,32 @@ export class GaugeModel extends GaugeModelSuperclass {
   accessor endAngle: number;
   /**
    * Gets the index of the feature to be rendered.
-   * - This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
-   * - For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
+   * - For statistic gauge, this property will be ignored.
+   * - For feature based gauge, if this property is not present, the first feature will be used (`featureIndex = 0`).
    */
   get featureIndex(): number | undefined;
   set featureIndex(value: number | null | undefined);
   /** Data field used for the gauge. */
   accessor field: string;
   /**
-   * Type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
+   * Type of gauge
+   * - `featureGauge` indicates that the gauge is based on a specific feature from the layer.
+   * - `statisticGauge` indicates that the gauge is based on a statistic value calculated from the layer's features.
    *
-   * **Note**: When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
+   * **Note**: When this property is not specified, it will be defaulted to `statisticGauge`.
    */
   get gaugeSubType(): GaugeChartSubTypes;
-  /** Content symbol for the inner label. */
+  /**
+   * Content symbol for the inner label.
+   *
+   * @example
+   * ```typescript
+   * gaugeModel.innerLabelContent = {
+   *   type: "esriTS",
+   *   text: "Inner label",
+   * };
+   * ```
+   */
   accessor innerLabelContent: WebChartTextSymbol | undefined;
   /** Whether the inner label is visible. */
   accessor innerLabelVisible: boolean;
@@ -57,25 +69,52 @@ export class GaugeModel extends GaugeModelSuperclass {
   accessor needleInnerRadius: number | null | undefined;
   /** Start width of the gauge's needle. */
   accessor needleStartWidth: number | null | undefined;
-  /** Symbol of the gauge's needle. */
+  /**
+   * Symbol of the gauge's needle.
+   *
+   * @example
+   * ```typescript
+   * gaugeModel.needleSymbol = {
+   *   type: "esriSFS",
+   *   color: [255, 0, 0, 255],
+   * };
+   * ```
+   */
   accessor needleSymbol: ISimpleFillSymbol | undefined;
   /** Visibility of the gauge's needle. */
   accessor needleVisibility: boolean;
   /** Whether to only show the first and last axis labels. */
   accessor onlyShowFirstAndLastLabels: boolean;
+  /**
+   * Gauge progress bands configuration.
+   *
+   * @example
+   * ```ts
+   * gaugeModel.progressBands = {
+   *  type: "fixed",
+   *  visible: true,
+   *  bands: {
+   *    target: { type: "esriSFS", color: [0, 255, 0, 255] },
+   *    base: { type: "esriSFS", color: [255, 0, 0, 255] }
+   *  }
+   * };
+   * ```
+   */
+  accessor progressBands: WebChartGaugeFixedProgressBands | undefined;
+  /** Whether progress bands are visible. */
+  accessor progressBandsVisibility: boolean;
   /** Start angle of the gauge. */
   accessor startAngle: number;
   /** Conversion to apply to the gauge value. */
   accessor valueConversion: ValueConversion | undefined;
   /** Generate the proper chart title given the current config. */
   generateChartTitle(): string;
-  /** Removes the existing feature index from the config object */
+  /** Removes the existing feature index from the config object. */
   removeFeatureIndex(): void;
   /**
    * Completes the async setup process for the chart model. Must be called before using the model.
    *
    * @param params
-   * @async **This method is `async` and must be awaited for the changes to take effect.**
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.Gauge>>): Promise<void>;
 }