@arcgis/charts-components 5.0.0-next.12 → 5.0.0-next.120

package/dist/loader.d.ts

@@ -1,2 +1,2 @@
-import "./index";
+import "./index.js";
 export declare const defineCustomElements: import("@arcgis/lumina").DefineCustomElements;

package/dist/loader.js

@@ -2,9 +2,9 @@ import { r as e } from "./chunks/runtime.js";
 import { makeDefineCustomElements as t } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.12 */
+v5.0.0-next.120 */
 const o = t(e, {
-  "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,allowUsingObjectIdStat,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,cursorRange,dataLabelFormatter:,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:,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-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,allowUsingObjectIdStat,autoDestroyDisabled,autoDisposeChart,autoInverseDataLabelTextColor,chartIndex,chartLimits:,chartWillRender:,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"), "actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,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"],
@@ -32,6 +32,9 @@ 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-popover": [() => import("./components/arcgis-charts-config-heat-chart-popover/customElement.js"), "colorRamps:,contentKind,headingTitle,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-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"],

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

@@ -1,7 +1,7 @@
 import { WebChart } from '../../spec';
 import { ChartConfig } from '../../utils';
 import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
+import { LayerInfo, ModelTypes, SerialChartDataSortingKinds } from '../interfaces/common';
 import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
 export declare class BarChartModel extends SerialChartModel {
     /**
@@ -14,35 +14,41 @@ export declare class BarChartModel extends SerialChartModel {
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * 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 {number} seriesIndex The index of the series.
-     * @returns {boolean | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesHideOversizedSideBySideLabels(seriesIndex: number): boolean | undefined;
     /**
      * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
-     * @param {boolean} hide The value for hiding oversized data labels.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param hide - The value for hiding oversized data labels.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
     /**
      * 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 {number} seriesIndex The index of the series.
-     * @returns {boolean | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
     /**
      * Sets whether to hide oversized stacked labels of the series based on the series index.
-     * @param {boolean} hide The value for hiding oversized stacked labels.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param hide - The value for hiding oversized stacked labels.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
+    /**
+     * Gets the sort order for the bar chart.
+     * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
+     */
+    getSortOrder(): SerialChartDataSortingKinds;
     /**
      * Resets the series styling to the default styling.
      */
     resetSeriesStyling(): void;
     /**
      * Returns whether the series styling is able to be reset.
-     * @returns {boolean}
      */
     resetAvailable(): boolean;
 }

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

@@ -2,32 +2,33 @@ import { ChartConfig } from '../../../utils';
 import { ModelTypes } from '../../interfaces/common';
 /**
  * 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 {number} seriesIndex The index of the series.
- * @param {ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>} config The chart configuration.
- * @returns {boolean | undefined}
+ *
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const getHideOversizedSideBySideLabels: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => boolean | undefined;
 /**
  * Sets whether to hide oversized data labels of the side-by-side series based on the series index.
- * @param {boolean} hide The value for hiding oversized labels.
- * @param {number} seriesIndex The index of the series.
- * @param {ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>} config The chart configuration.
  *
  * **NOTE:** This method will only work if the series is a bar chart series.
+ *
+ * @param hide - The value for hiding oversized labels.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setHideOversizedSideBySideLabels: (hide: boolean | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => void;
 /**
  * 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 {number} seriesIndex The index of the series.
- * @param {ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>} config The chart configuration.
- * @returns {boolean | undefined}
+ *
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const getHideOversizedStackedLabels: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => boolean | undefined;
 /**
  * Sets whether to hide oversized data labels of the stacked series based on the series index.
- * @param {boolean} hide The value for hiding oversized stacked labels.
- * @param {number} seriesIndex The index of the series.
- * @param {ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>} config The chart configuration.
+ * @param hide - The value for hiding oversized stacked labels.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  *
  * **NOTE:** This method will only work if the series is a bar chart series.
  */

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

@@ -3,7 +3,20 @@ import { Color, RESTSimpleLineSymbolStyle, WebChart, WebChartDataFilters } from
 import { ChartModel } from '../chart-model/chart-model';
 import { ModelParams } from '../interfaces/chart-interfaces';
 import { ModelTypes, BoxPlotDataSortingKinds } from '../interfaces/common';
-import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithMultiAxes, ModelWithRotation, ModelWithTooltips, ModelWithYGuides } from '../mixins';
+import { ModelWithLegend, ModelWithMultiAxes, ModelWithTooltips, ModelWithYGuides } from '../mixins';
+import { WithAxisLabelsSymbol } from '../properties/axes/axis-labels-symbol';
+import { WithAxisLinesSymbol } from '../properties/axes/axis-lines-symbol';
+import { WithXBounds } from '../properties/axes/x-axis/x-bounds';
+import { WithXAxisLabelsVisibility } from '../properties/axes/x-axis/x-axis-labels-visibility';
+import { WithXAxisTitleSymbol } from '../properties/axes/x-axis/x-axis-title-symbol';
+import { WithXAxisTitleText } from '../properties/axes/x-axis/x-axis-title-text';
+import { WithXAxisTitleVisibility } from '../properties/axes/x-axis/x-axis-title-visibility';
+import { WithGenerateXAxisTitle } from '../properties/axes/x-axis/generate-x-axis-title';
+import { WithColorMatch } from '../properties/color-match';
+import { WithRotatedState } from '../properties/rotated-state';
+import { WithDataLabelsVisibility } from '../properties/data-labels/data-labels-visibility';
+import { WithDataLabelsSymbol } from '../properties/data-labels/data-labels-symbol';
+import { MixinInstances } from '../shared/utils';
 export declare class BoxPlotModel extends ChartModel {
     /**
      * Current configuration used for the box plot chart.
@@ -12,22 +25,18 @@ export declare class BoxPlotModel extends ChartModel {
     protected _chartType: XYChartTypes;
     /**
      * Internal storage of the category field for the chart.
-     * @category Protected
      */
     protected _category: string;
     /**
      * Internal storage of the split-by field for the chart.
-     * @category Protected
      */
     protected _splitByField: string;
     /**
      * Internal storage of the numeric fields for the chart.
-     * @category Protected
      */
     protected _numericFields: string[];
     /**
      * The previous mean lines box color. We save this so that we can recover the color previously set if the user toggles mean lines off and then back on.
-     * @category Private
      */
     private previousMeanLinesBoxColor;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.BoxPlot>>): Promise<void>;
@@ -58,23 +67,23 @@ export declare class BoxPlotModel extends ChartModel {
     set standardizeValues(newStandardizeValuesState: boolean);
     /**
      * Gets the sort order of the box plot data.
-     * @returns {"xAxisAsc" | "xAxisDesc"| "meanAsc" | "meanDesc" | "medianAsc" | "medianDesc" | "customSort"}
      */
     getSortOrder(): BoxPlotDataSortingKinds;
     /**
      * Sets the sort order of the box plot data.
-     * @param {"xAxisAsc" | "xAxisDesc"| "meanAsc" | "meanDesc" | "medianAsc" | "medianDesc" | "customSort"} newSortOrder The new sort order.
-     * @param {string[]} orderByList The new list of category's values for custom sort.
+     *
+     * @param newSortOrder - The new sort order.
+     * @param orderByList - The new list of category's values for custom sort.
      */
     setSortOrder(newSortOrder: BoxPlotDataSortingKinds, orderByList?: string[]): void;
     /**
      * Gets the list of the category values for the chart.
-     * @returns {string[]}
      */
     getCustomSortValues(): Promise<string[]>;
     /**
      * Sets the data filter for the bar chart.
-     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     *
+     * @param newDataFilter - The new data filter.
      */
     setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
     /**
@@ -99,7 +108,6 @@ export declare class BoxPlotModel extends ChartModel {
     set meanLinesBoxColor(newColor: Color | undefined);
     /**
      * Sets up the local props based on the current config.
-     * @category Protected
      */
     protected setupLocalProps(): void;
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
@@ -112,13 +120,11 @@ export declare class BoxPlotModel extends ChartModel {
      * We can call the build new series function synchronously when either is true:
      * - there is no split-by field
      * - there are multiple numeric fields
-     * @category Protected
      */
     protected canUseSynchronousSeriesRebuild(): boolean;
     /**
      * Processes the series rebuild.
      * If multiple async setters are called in succession, this function will only rebuild the series once after all setters have been called.
-     * @category Protected
      * @async
      */
     protected processSeriesRebuild(): Promise<void>;
@@ -128,62 +134,62 @@ export declare class BoxPlotModel extends ChartModel {
     private getBuildNewSeriesProps;
     /**
      * Gets the name of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {string | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesName(seriesIndex: number): string | undefined;
     /**
      * Sets name of the series based on the series index.
-     * @param {string} newName The new name for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param newName - The new name for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesName(newName: string, seriesIndex: number): void;
     /**
      * Gets the color of the series based on the series index. If the index is out of bounds, it will return `undefined`.
-     * @param {number} seriesIndex The index of the series.
-     * @returns {Color | undefined}
+     *
+     * @param seriesIndex - The index of the series.
      */
     getSeriesColor(seriesIndex: number): Color | undefined;
     /**
      * Sets the color of the series based on the series index.
-     * @param {Color | undefined} newColor The new color for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param newColor - The new color for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesColor(newColor: Color | undefined, seriesIndex: number): void;
     /**
      * Gets the line style of the series based on the series index. If the index is out of bounds, it will return `undefined`.
      *
-     * **Only applicable when mean lines are shown.**
+     * **Note**: Only applicable when mean lines are shown.
      *
-     * @param {number} seriesIndex The index of the series.
-     * @returns {RESTSimpleLineSymbolStyle | undefined}
+     * @param seriesIndex - The index of the series.
      */
     getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
     /**
      * Sets the line style of the series based on the series index.
      *
-     * **Only applicable when mean lines are shown.**
+     * **Note**: Only applicable when mean lines are shown.
      *
-     * @param {RESTSimpleLineSymbolStyle | undefined} newStyle The new style for the series.
-     * @param {number} seriesIndex The index of the series.
+     * @param newStyle - The new style for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesLineStyle(newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
     /**
      * Gets the line width of the series based on the series index. If the index is out of bounds, it will return `undefined`.
      *
-     * **Only applicable when mean lines are shown.**
+     * **Note**: Only applicable when mean lines are shown.
      *
-     * @param {number} seriesIndex The index of the series.
-     * @returns {number | undefined}
+     * @param seriesIndex - The index of the series.
      */
     getSeriesLineWidth(seriesIndex: number): number | undefined;
     /**
      * Sets the line width of the series based on the series index.
      *
-     * **Only applicable when mean lines are shown.**
+     * **Note**: Only applicable when mean lines are shown.
      *
-     * @param {number | undefined} newWidth The new width for the series.
-     * @param {number} seriesIndex The index of the series.
+     * @param newWidth - The new width for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
     /**
@@ -193,32 +199,29 @@ export declare class BoxPlotModel extends ChartModel {
     set orderOfSeries(newOrder: string[]);
     /**
      * Moves a series from one index in the series array to another.
-     * @param {number} fromIndex Index to move the series from.
-     * @param {number} toIndex Index to move the series to.
+     *
+     * @param fromIndex - Index to move the series from.
+     * @param toIndex - Index to move the series to.
      */
     moveSeries(fromIndex: number, toIndex: number): void;
     /**
      * 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;
     /**
      * Move the custom sort values in-place for the order by list in the config.
-     * **Note:** This method should be only used when the sort order is set to `BoxPlotDataSortingKinds.customSort`.
-     * @param {number} fromIndex The index to move the custom sort item from.
-     * @param {number} toIndex The index to move the category item to.
+     *
+     * **Note**: This method should be only used when the sort order is set to `BoxPlotDataSortingKinds.customSort`.
+     * @param fromIndex - The index to move the custom sort item from.
+     * @param toIndex - The index to move the category item to.
      */
     moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
     /**
      * Generate the proper chart title given the current config.
      */
     generateChartTitle(): string;
-    /**
-     * Generate the proper x-axis title given the current config.
-     *
-     * @returns {string}
-     */
-    generateXAxisTitle(): string;
     /**
      * Generate the proper y-axis title given the current config.
      */
@@ -229,9 +232,10 @@ export declare class BoxPlotModel extends ChartModel {
     resetSeriesStyling(): void;
     /**
      * Returns whether the series styling is able to be reset.
-     * @returns {boolean}
      */
     resetAvailable(): boolean;
 }
-export interface BoxPlotModel extends ModelWithMultiAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithRotation, ModelWithDataLabels, ModelWithYGuides {
+declare const boxPlotMixins: readonly [typeof ModelWithMultiAxes, typeof ModelWithLegend, typeof ModelWithTooltips, typeof WithColorMatch, typeof WithRotatedState, typeof WithDataLabelsVisibility, typeof WithDataLabelsSymbol, typeof ModelWithYGuides, typeof WithXAxisTitleText, typeof WithXAxisLabelsVisibility, typeof WithXAxisTitleVisibility, typeof WithXBounds, typeof WithXAxisTitleSymbol, typeof WithAxisLabelsSymbol, typeof WithAxisLinesSymbol, typeof WithGenerateXAxisTitle];
+export interface BoxPlotModel extends MixinInstances<typeof boxPlotMixins> {
 }
+export {};

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

@@ -10,17 +10,13 @@ export declare const getCategory: (config: BoxPlotConfig) => string;
  */
 export declare const getSplitByField: (config: BoxPlotConfig) => string;
 /**
- * get the numeric fields from the config object
+ * Gets the numeric fields from the config object.
+ *
  * @param config - box plot config object
  */
 export declare const getNumericFields: (config: BoxPlotConfig) => string[];
 /**
  * Builds a new series array based on the provided props.
- * @param props.splitByField
- * @param props.numericFields
- * @param props.config
- * @param props.layerInfo
- * @param props.commonStrings
  */
 export declare const buildNewSeries: (props: {
     splitByField: string;
@@ -36,20 +32,23 @@ export declare const buildNewSeries: (props: {
 export declare const getStandardizeValues: (config: BoxPlotConfig) => boolean;
 /**
  * Gets the proper Y-axis title label based on the chart configuration.
- * @param {BoxPlotConfig} config - The box plot config
- * @param {LayerInfo} layerInfo - The layer info
- * @param {CommonStrings} commonStrings - The common strings
+ *
+ * @param config - The box plot config
+ * @param layerInfo - The layer info
+ * @param commonStrings - The common strings
  */
 export declare function getYAxisTitleLabel(config: BoxPlotConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
 /**
  * Generates the proper chart title given the current config.
- * @param {BoxPlotConfig} config - The box plot config
- * @param {LayerInfo} layerInfo - The layer info
- * @param {CommonStrings} commonStrings - The common strings
+ *
+ * @param config - The box plot config
+ * @param layerInfo - The layer info
+ * @param commonStrings - The common strings
  */
 export declare function getChartTitle(config: BoxPlotConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
 /**
  * Gets the default series name.
+ *
  * @param props.series - The series to get the name for
  * @param props.splitByField - The split-by field
  * @param props.layerInfo - The layer info
@@ -63,7 +62,6 @@ export declare const getDefaultSeriesName: (props: {
 }) => string;
 /**
  * Gets whether the outliers are shown.
- * @param config
  */
 export declare const getShowOutliers: (config: BoxPlotConfig) => boolean;
 /**

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

@@ -0,0 +1,104 @@
+import { ModelParams } from '../interfaces/chart-interfaces';
+import { LayerInfo, ModelTypes } from '../interfaces/common';
+import { ChartConfig, ChartTypes, CommonStrings } from '../../utils';
+import { ChartModel } from './chart-model';
+export declare abstract class ChartModelBase extends EventTarget {
+    /**
+     * Current configuration used for the chart.
+     */
+    protected _config: ChartConfig;
+    /**
+     * Grouping of layer-related properties to be passed to external function more compactly.
+     */
+    protected layerInfo: LayerInfo;
+    /**
+     * Common strings used in the model.
+     */
+    protected commonStrings: CommonStrings;
+    /**
+     * Chart type.
+     */
+    protected _chartType: ChartTypes;
+    /**
+     * List of setters (either props or methods) that have been changed and will require an async series rebuild.
+     */
+    protected dirtyAsyncSetters: string[];
+    /**
+     * Whether or not an async series update is currently in progress.
+     */
+    protected asyncConfigUpdateInProgress: boolean;
+    /**
+     * Number of pending async updates.
+     */
+    protected pendingUpdates: number;
+    /**
+     * Function that resolves the setup promise.
+     */
+    protected resolveSetup?: () => void;
+    /**
+     * 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>;
+    /**
+     * The chart type.
+     */
+    get chartType(): typeof this._chartType;
+    /**
+     * Checks if the current chart model is for the same chart as another chart model.
+     *
+     * @param otherModel - The other chart model to compare to.
+     */
+    isSameChartAs(otherModel: ChartModel | undefined): boolean;
+    /**
+     * Generate the proper chart title from the current config.
+     */
+    abstract generateChartTitle(): string;
+    /**
+     * Can be awaited to allow any pending async updates to complete.
+     * @public
+     */
+    update(): Promise<void>;
+    /**
+     * Data store object that can be used to store any data needed for the chart.
+     */
+    dataStore: any;
+    /**
+     * Promise that resolves when the setup process is complete.
+     *
+     * **Note:** This promise does not need to be awaited if the `setup` method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.
+     */
+    asyncUpdatesPromise: Promise<void>;
+    /**
+     * Emits a config update event.
+     */
+    protected emitConfigUpdate: (setterName: string) => void;
+    /**
+     * A function that generates the default config object when creating a new chart.
+     */
+    protected abstract generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
+    /**
+     * A function that loads the config based on the provided props.
+     *
+     * @param params.layer - The layer to be used as the data source for the chart.
+     * @param params.iLayer - The layer description to use if the layer is not provided.
+     * @param params.config - The config object to be loaded.
+     */
+    protected loadConfigFromLayer<T extends ModelTypes>(params: ModelParams<ChartConfig<T>>): Promise<void>;
+    /**
+     * Manually block the async guard to queue up config updates until unblocked.
+     */
+    protected startAsyncUpdate(): void;
+    /**
+     * Manually unblock the async guard to allow queued config updates to proceed.
+     */
+    protected finishAsyncUpdate(): void;
+    /**
+     * Guards a setter from being called while an async config update is in progress so that the value being set is not overwritten by the async config update.
+     *
+     * @param setter - The setter callback to call after setup or async config update is finished.
+     */
+    protected guardSetterFromAsyncOverwrite: (setter: (() => Promise<void>) | (() => void)) => Promise<void>;
+}