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

package/dist/interfaces.d.ts

@@ -87,7 +87,7 @@ export declare const HistogramDataPopoverKinds: {
     readonly lineSymbol: "lineSymbol";
 };
 export type HistogramDataPopoverKinds = (typeof HistogramDataPopoverKinds)[keyof typeof HistogramDataPopoverKinds];
-export declare const ScatterPlotDataPopoverKinds: {
+export declare const ScatterplotDataPopoverKinds: {
     readonly xAxisField: "xAxis";
     readonly yAxisField: "yAxis";
     readonly sizeVariable: "sizeVariable";
@@ -95,7 +95,7 @@ export declare const ScatterPlotDataPopoverKinds: {
     readonly trendLine: "trendLine";
     readonly none: "none";
 };
-export type ScatterPlotDataPopoverKinds = (typeof ScatterPlotDataPopoverKinds)[keyof typeof ScatterPlotDataPopoverKinds];
+export type ScatterplotDataPopoverKinds = (typeof ScatterplotDataPopoverKinds)[keyof typeof ScatterplotDataPopoverKinds];
 export interface NumericFieldsChangeProps {
     pickListElement: HTMLCalciteListElement | undefined;
     eventEmitter: EventEmitter<unknown>;
@@ -108,13 +108,40 @@ export declare const BoxPlotDataPopoverKinds: {
     readonly sortOrder: "sortOrder";
 };
 export type BoxPlotDataPopoverKinds = (typeof BoxPlotDataPopoverKinds)[keyof typeof BoxPlotDataPopoverKinds];
-export declare const ScatterPlotSymbolSizeTypes: {
+export declare const ScatterplotSymbolSizeTypes: {
     readonly Fixed: "fixed";
     readonly Proportional: "proportional";
 };
-export type ScatterPlotSymbolSizeTypes = (typeof ScatterPlotSymbolSizeTypes)[keyof typeof ScatterPlotSymbolSizeTypes];
+export type ScatterplotSymbolSizeTypes = (typeof ScatterplotSymbolSizeTypes)[keyof typeof ScatterplotSymbolSizeTypes];
 export declare const ButtonDirections: {
     readonly Up: "up";
     readonly Down: "down";
 };
 export type ButtonDirections = (typeof ButtonDirections)[keyof typeof ButtonDirections];
+/**
+ * Options for CSV export.
+ * @template T - The type of the data being exported.
+ */
+export interface CSVOptions {
+    /**
+     * Explicit list of columns to export.
+     * If not provided, all columns will be exported.
+     * @default undefined
+     */
+    columns?: string[];
+    /**
+     * Field delimiter.
+     * @default ","
+     */
+    delimiter?: string;
+    /**
+     * Whether to include the header row in the CSV.
+     * @default true
+     */
+    includeHeader?: boolean;
+    /**
+     * Whether to quote all fields.
+     * @default false
+     */
+    quoteAll?: boolean;
+}

package/dist/loader.js

@@ -1,11 +1,11 @@
 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/4.33/esri/copyright.txt for details.
-v4.33.0-next.99 */
+See https://js.arcgis.com/4.34/esri/copyright.txt for details.
+v4.34.0-next.1 */
 const o = t(e, {
-  "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,autoDisposeChart,chartLimits:,chartWillRender:,componentVersion,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,ignoreSmoothRenderingLimit,ignoreViewExtent,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,messageOptions:,model:,placeholder,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionTheme:,setTimeBinningInfoWhenNotProvided,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,errorAlert,exportImage,notify,refresh,resetZoom,switchSelection"],
-  "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,editChartState,editChartTitle,editChartToggle,expanded,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-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,autoDisposeChart,chartLimits:,chartWillRender:,componentVersion,cursorRange,dataLabelFormatter:,disableInteractions,disableTogglingLegendItems,enableConfiguration,enableResponsiveFeatures,errorPolicy,featureIndex,filterByExtent,filterBySelection,gaugeInnerLabelFormatter:,guideTooltipFormatter:,hideEmptySeries,hideLicenseWatermark,hideLoaderAnimation,ignoreSmoothRenderingLimit,ignoreViewExtent,layer:,layerFieldsChangePolicy,layerFilterChangePolicy,layerRendererChangePolicy,legendPosition,legendValueLabelFormatter:,legendVisibility,loaderColors:,messageOptions:,model:,placeholder,queueChartCreation,replaceNoValueCategoryWithZero,returnFeaturesExtent,returnSelectionIndexes,returnSelectionOIDs,rotation,runtimeDataFilters:,secondaryYAxisLabelFormatter:,selectionData:,selectionTheme:,setTimeBinningInfoWhenNotProvided,syncSelection,syncSelectionsBetweenChartAndLayerViewPolicy,timeZone,tooltipFormatter:,updateSplitBySeries:,useAnimatedCharts,usePopupTemplateFieldsInfo,view:,viewTimeExtentChangePolicy,xAxisLabelFormatter:,yAxisLabelFormatter:;clearSelection,errorAlert,exportAsCSV,exportAsImage,notify,refresh,resetZoom,switchSelection"],
+  "arcgis-charts-action-bar": [() => import("./components/arcgis-charts-action-bar/customElement.js"), "actionBarSelectionMode,chartElement:,chartType,clearSelectionState,clearSelectionTitle,clearSelectionToggle,disableCSVExportForChartTypes:,disabledExportAction,editChartState,editChartTitle,editChartToggle,expanded,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"],
@@ -50,7 +50,7 @@ const o = t(e, {
   "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-data": [() => import("./components/arcgis-charts-config-scatter-plot-data/customElement.js"), "isTableLayer,layerFieldsInfo:,messageOverrides:,model:,open,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,popoverReferenceElement:,selectedChartType;reposition"],
+  "arcgis-charts-config-select-chart-type-popover": [() => import("./components/arcgis-charts-config-select-chart-type-popover/customElement.js"), "headerTitle,layerId,messageOverrides:,open,popoverPlacement,popoverReferenceElement:,selectedModelType;reposition"],
   "arcgis-charts-config-view-charts": [() => import("./components/arcgis-charts-config-view-charts/customElement.js"), "disableEditing,layer:,messageOverrides:,modelList:,noGroup,selectedChartId"]
 });
 export {

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

@@ -1,17 +1,34 @@
-import { WebChart, WebChartBarChartSeries } from '@arcgis/charts-spec';
-import { ChartConfig } from '@arcgis/charts-shared-utils';
-import { LayerInfo } from '../interfaces/common';
+import { WebChart } from '@arcgis/charts-spec';
+import { ChartConfig } from '../../utils';
 import { ModelParams } from '../interfaces/chart-interfaces';
-import { SerialChartModel } from '../serial-chart-model/customElement.js';
+import { LayerInfo, ModelTypes } from '../interfaces/common';
+import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
 export declare class BarChartModel extends SerialChartModel {
+    /**
+     * Common strings used in the model.
+     * @category Private
+     */
+    private commonStrings;
     /**
      * Current configuration used for the bar chart.
      */
-    protected _config: ChartConfig<WebChartBarChartSeries, WebChart>;
+    protected _config: ChartConfig<typeof ModelTypes.BarChart, WebChart>;
     protected _chartType: "barSeries";
     protected layerInfo: LayerInfo;
-    setup(params: ModelParams<ChartConfig<WebChartBarChartSeries>>): Promise<void>;
+    setup(params: ModelParams<ChartConfig<typeof ModelTypes.BarChart>>): Promise<void>;
     protected generateDefaultConfig(): Promise<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}
+     */
+    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.
+     */
+    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.
@@ -20,17 +37,17 @@ export declare class BarChartModel extends SerialChartModel {
     getSeriesHideOversizedStackedLabels(seriesIndex: number): boolean | undefined;
     /**
      * Sets whether to hide oversized stacked labels of the series based on the series index.
-     * @param {boolean} newValue The new value for hiding oversized stacked labels.
+     * @param {boolean} hide The value for hiding oversized stacked labels.
      * @param {number} seriesIndex The index of the series.
      */
-    setSeriesHideOversizedStackedLabels(newValue: boolean | undefined, seriesIndex: number): void;
+    setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
     /**
      * Resets the series styling to the default styling.
      */
-    resetSeriesStyling(): Promise<void>;
+    resetSeriesStyling(): void;
     /**
      * Returns whether the series styling is able to be reset.
      * @returns {boolean}
      */
-    resetAvailable(): Promise<boolean>;
+    resetAvailable(): boolean;
 }

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

@@ -1,4 +1,34 @@
-import { WebChartBarChartSeries } from '@arcgis/charts-spec';
-import { ChartConfig } from '@arcgis/charts-shared-utils';
-export declare const getHideOversizedStackedLabels: (seriesIndex: number, config: ChartConfig<WebChartBarChartSeries>) => boolean | undefined;
-export declare const setHideOversizedStackedLabels: (newValue: boolean | undefined, seriesIndex: number, config: ChartConfig<WebChartBarChartSeries>) => void;
+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}
+ */
+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.
+ */
+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}
+ */
+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.
+ *
+ * **NOTE:** This method will only work if the series is a bar chart series.
+ */
+export declare const setHideOversizedStackedLabels: (hide: boolean | undefined, seriesIndex: number, config: ChartConfig<typeof ModelTypes.BarChart> | ChartConfig<typeof ModelTypes.ComboBarLineChart>) => void;

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

@@ -1,14 +1,14 @@
-import { ChartConfig, XYChartTypes } from '@arcgis/charts-shared-utils';
-import { Color, RESTSimpleLineSymbolStyle, WebChart, WebChartBoxPlotSeries, WebChartDataFilters } from '@arcgis/charts-spec';
-import { ChartModel } from '../chart-model/customElement.js';
+import { ChartConfig, XYChartTypes } from '../../utils';
+import { Color, RESTSimpleLineSymbolStyle, WebChart, WebChartDataFilters } from '@arcgis/charts-spec';
+import { ChartModel } from '../chart-model/chart-model';
 import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, BoxPlotDataSortingKinds } from '../interfaces/common';
+import { LayerInfo, ModelTypes, BoxPlotDataSortingKinds } from '../interfaces/common';
 import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithRotation, ModelWithTooltips, ModelWithXYAxes, ModelWithYGuides } from '../mixins';
 export declare class BoxPlotModel extends ChartModel {
     /**
      * Current configuration used for the box plot chart.
      */
-    protected _config: ChartConfig<WebChartBoxPlotSeries, WebChart>;
+    protected _config: ChartConfig<typeof ModelTypes.BoxPlot, WebChart>;
     protected _chartType: XYChartTypes;
     protected layerInfo: LayerInfo;
     /**
@@ -21,7 +21,7 @@ export declare class BoxPlotModel extends ChartModel {
      * @category Private
      */
     private previousMeanLinesBoxColor;
-    setup(params: ModelParams<ChartConfig<WebChartBoxPlotSeries>>): Promise<void>;
+    setup(params: ModelParams<ChartConfig<typeof ModelTypes.BoxPlot>>): Promise<void>;
     /**
      * Gets the category field for the box plot.
      * @returns {string}
@@ -139,6 +139,10 @@ export declare class BoxPlotModel extends ChartModel {
      */
     setMeanLinesBoxColor(newColor: Color | undefined): void;
     protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    /**
+     * Resets the config to the default config
+     */
+    resetConfig(): Promise<void>;
     /**
      * 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.

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

@@ -1,6 +1,6 @@
-import { BoxPlotConfig, ChartConfig } from '@arcgis/charts-shared-utils';
+import { BoxPlotConfig, ChartConfig } from '../../../utils';
 import { Color, WebChartBoxPlotSeries, WebChartDataFilters, WebChartLineChartSeries } from '@arcgis/charts-spec';
-import { LayerInfo, BoxPlotDataSortingKinds } from '../../interfaces/common';
+import { LayerInfo, ModelTypes, BoxPlotDataSortingKinds } from '../../interfaces/common';
 import { ModelCommonStrings } from '../../t9n/common/interfaces';
 /**
  * Gets the category field.
@@ -46,8 +46,17 @@ export declare const setCategory: (newCategory: string, config: BoxPlotConfig, l
 export declare const setNumericFields: (newNumericFields: string[], config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
 /**
  * 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
+ * @param props.commonStrings - The common strings
  */
-export declare const getDefaultSeriesName: (series: WebChartBoxPlotSeries | WebChartLineChartSeries, splitByField: string, layerInfo: LayerInfo, commonStrings: ModelCommonStrings) => string;
+export declare const getDefaultSeriesName: (props: {
+    series: WebChartBoxPlotSeries | WebChartLineChartSeries;
+    splitByField: string;
+    layerInfo: LayerInfo;
+    commonStrings: ModelCommonStrings;
+}) => string;
 /**
  * Sets the split-by field by updating the config accordingly.
  */
@@ -75,7 +84,7 @@ export declare const getSortOrderKind: (config: BoxPlotConfig) => BoxPlotDataSor
 /**
  * Sets the sort order.
  */
-export declare const setSortOrderKind: (newSortOrderKind: BoxPlotDataSortingKinds, config: ChartConfig<WebChartBoxPlotSeries>, orderByList?: string[]) => void;
+export declare const setSortOrderKind: (newSortOrderKind: BoxPlotDataSortingKinds, config: ChartConfig<typeof ModelTypes.BoxPlot>, orderByList?: string[]) => void;
 /**
  * Gets whether the mean lines are shown.
  * @param config
@@ -92,34 +101,34 @@ export declare const setShowMeanLines: (newShowMeanLines: boolean | undefined, c
 }>;
 /**
  * Get the order by list from the config. The order by list is only used when the sort order kind is custom sort.
- * @param  {ChartConfig<WebChartBoxPlotSeries} config - The chart config.
+ * @param  {ChartConfig<typeof ModelTypes.BoxPlot>} config - The chart config.
  *
  * @returns string[] - The order by list.
  */
-export declare const getOrderByList: (config: ChartConfig<WebChartBoxPlotSeries>) => string[];
+export declare const getOrderByList: (config: ChartConfig<typeof ModelTypes.BoxPlot>) => string[];
 /**
  * Set the order by list in the config. The order by list is only used when the sort order kind is custom sort.
  * @param  {string[]} values - The order by list.
- * @param  {ChartConfig<WebChartBoxPlotSeries} config - The chart config.
+ * @param  {ChartConfig<typeof ModelTypes.BoxPlot>} config - The chart config.
  */
-export declare const setOrderByList: (values: string[], config: ChartConfig<WebChartBoxPlotSeries>) => void;
+export declare const setOrderByList: (values: string[], config: ChartConfig<typeof ModelTypes.BoxPlot>) => void;
 /**
  * Get the data filter from the config.
- * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
+ * @param  {ChartConfig<typeof ModelTypes.BoxPlot>} config - The chart config.
  * @returns WebChartDataFilters | undefined - The data filter.
  */
-export declare const getDataFilter: (config: ChartConfig<WebChartBoxPlotSeries>) => WebChartDataFilters | undefined;
+export declare const getDataFilter: (config: ChartConfig<typeof ModelTypes.BoxPlot>) => WebChartDataFilters | undefined;
 /**
  * Set the data filter in the config.
  * @param  {WebChartDataFilters | undefined} dataFilter - The data filter.
- * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
+ * @param  {ChartConfig<typeof ModelTypes.BoxPlot>} config - The chart config.
  */
-export declare const setDataFilter: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig<WebChartBoxPlotSeries>) => void;
+export declare const setDataFilter: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig<typeof ModelTypes.BoxPlot>) => void;
 /**
  * Get the custom sort values from the config.
- * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
+ * @param  {ChartConfig<typeof ModelTypes.BoxPlot>} config - The chart config.
  * @param  {LayerInfo} layerInfo - The layer info.
  *
  * @returns string[] - The custom sort values.
  */
-export declare const getCustomSortValues: (config: ChartConfig<WebChartBoxPlotSeries>, layerInfo: LayerInfo) => Promise<string[]>;
+export declare const getCustomSortValues: (config: ChartConfig<typeof ModelTypes.BoxPlot>, layerInfo: LayerInfo) => Promise<string[]>;

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

@@ -1,5 +1,5 @@
 import { Color } from '@arcgis/charts-spec';
-import { BoxPlotConfig } from '@arcgis/charts-shared-utils';
+import { BoxPlotConfig } from '../../../utils';
 /**
  * get series name of the given series from the in config object using series index
  * @param seriesIndex - index of series in series array

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

@@ -1,7 +1,7 @@
-import { ChartConfig, ChartSubType, ChartTypes, SupportedChartSeries } from '@arcgis/charts-shared-utils';
-import { Color, LegendItemVisibility, SupportedLayer, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { Color, IDrawingInfo, LegendItemVisibility, SupportedLayer, WebChartTextSymbol } from '@arcgis/charts-spec';
 import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo } from '../interfaces/common';
+import { LayerInfo, ModelTypes } from '../interfaces/common';
+import { ChartConfig, ChartSubType, ChartTypes } from '../../utils';
 export declare abstract class ChartModel extends EventTarget {
     /**
      * Current configuration used for the chart.
@@ -29,13 +29,13 @@ export declare abstract class ChartModel extends EventTarget {
     dataStore: any;
     /**
      * Completes the async setup process for the chart model. Must be called before using the model.
-     * @param {ModelParams} params - The parameters to be used to set up the chart model.
+     * @param {ModelParams} 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>;
     /**
      * Checks if the current chart model is for the same chart as another chart model.
-     * @param {ChartModel | undefined} otherModel - The other chart model to compare to.
+     * @param {ChartModel | undefined} otherModel The other chart model to compare to.
      * @returns {boolean}
      */
     isSameChartAs(otherModel: ChartModel | undefined): boolean;
@@ -46,9 +46,9 @@ export declare abstract class ChartModel extends EventTarget {
     getConfig(): ChartConfig;
     /**
      * Sets the chart configuration object.
-     * @param {ChartConfig} newConfig - The new configuration object.
+     * @param {ChartConfig} config The configuration object.
      */
-    setConfig(newConfig: ChartConfig): void;
+    setConfig(config: ChartConfig): void;
     /**
      * Gets the chart type.
      * @returns {ChartTypes}
@@ -66,15 +66,20 @@ export declare abstract class ChartModel extends EventTarget {
     getChartId(): string | undefined;
     /**
      * Sets the chart id.
-     * @param {string} newId
+     * @param {string} id
      */
-    setChartId(newId: string): void;
+    setChartId(id: string): void;
     /**
      * 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.**
      */
     setupFinished: Promise<void>;
+    /**
+     * Gets the version of the chart configuration.
+     * @returns {string}
+     */
+    getVersion(): string;
     /**
      * Gets the chart title text.
      * @returns {string}
@@ -82,9 +87,9 @@ export declare abstract class ChartModel extends EventTarget {
     getTitleText(): string;
     /**
      * Sets the chart title text.
-     * @param {string} newTitle - The new title text.
+     * @param {string} title The title text.
      */
-    setTitleText(newTitle: string): void;
+    setTitleText(title: string): void;
     /**
      * Gets the chart subtitle text.
      * @returns {string}
@@ -92,9 +97,9 @@ export declare abstract class ChartModel extends EventTarget {
     getSubtitleText(): string;
     /**
      * Sets the chart subtitle text.
-     * @param {string} newSubTitle - The new subtitle text.
+     * @param {string} subtitle The subtitle text.
      */
-    setSubtitleText(newSubTitle: string): void;
+    setSubtitleText(subtitle: string): void;
     /**
      * Gets the chart description text.
      * @returns {string}
@@ -102,11 +107,11 @@ export declare abstract class ChartModel extends EventTarget {
     getDescriptionText(): string;
     /**
      * Sets the chart description text.
-     * @param {string} newDescription - The new description text.
+     * @param {string} description The description text.
      */
-    setDescriptionText(newDescription: string): void;
+    setDescriptionText(description: string): void;
     /**
-     * Gets whether the chart title is visible or not.
+     * Gets whether or not the chart title is visible.
      *
      * `true`: Chart title is visible.
      *
@@ -118,19 +123,43 @@ export declare abstract class ChartModel extends EventTarget {
      */
     getChartTitleVisibility(): boolean;
     /**
-     * Sets whether the chart title is visible or not.
+     * Sets whether or not the chart title is visible.
      *
      * `true`: Show chart title.
      *
      * `false`: Hide chart title.
      *
-     * @param {boolean} newVisibility - The new visibility state of the chart title.
+     * @param {boolean} visibility The visibility state of the chart title.
      *
      * **Note: Even if the title is visible, it may not be displayed if the title text is empty.**
      */
-    setChartTitleVisibility(newVisibility: boolean): void;
+    setChartTitleVisibility(visibility: boolean): void;
+    /**
+     * Gets whether or not the chart subtitle is visible.
+     *
+     * `true`: Chart subtitle is visible.
+     *
+     * `false`: Chart subtitle is hidden.
+     *
+     * @returns {boolean}
+     *
+     * **Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.**
+     */
+    getChartSubtitleVisibility(): boolean;
     /**
-     * Gets whether the chart description is visible or not.
+     * Sets whether or not the chart subtitle is visible.
+     *
+     * `true`: Show chart subtitle.
+     *
+     * `false`: Hide chart subtitle.
+     *
+     * @param {boolean} visibility The visibility state of the chart subtitle.
+     *
+     * **Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.**
+     */
+    setChartSubtitleVisibility(visibility: boolean): void;
+    /**
+     * Gets whether or not the chart description is visible.
      *
      * `true`: Description is visible.
      *
@@ -142,17 +171,27 @@ export declare abstract class ChartModel extends EventTarget {
      */
     getDescriptionVisibility(): boolean;
     /**
-     * Sets whether the chart description is visible or not.
+     * Sets whether or not the chart description is visible.
      *
      * `true`: Show description.
      *
      * `false`: Hide description.
      *
-     * @param {boolean} newVisibility - The new visibility state of the description.
+     * @param {boolean} visibility The visibility state of the description.
      *
      * **Note: Even if the description is visible, it may not be displayed if the description text is empty.**
      */
-    setDescriptionVisibility(newVisibility: boolean): void;
+    setDescriptionVisibility(visibility: boolean): void;
+    /**
+     * Gets the chart renderer.
+     * @returns {IDrawingInfo["renderer"] | undefined} The chart renderer if defined, otherwise undefined.
+     */
+    getChartRenderer(): IDrawingInfo["renderer"] | undefined;
+    /**
+     * Sets the chart renderer.
+     * @param renderer The chart renderer to set.
+     */
+    setChartRenderer(renderer: IDrawingInfo["renderer"]): void;
     /**
      * Gets the title text symbol. Contains styling information such as font, color, and symbol style.
      * @returns {WebChartTextSymbol | undefined}
@@ -160,9 +199,19 @@ export declare abstract class ChartModel extends EventTarget {
     getTitleSymbol(): WebChartTextSymbol | undefined;
     /**
      * Sets the title text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} newTitleSymbol - The new title symbol.
+     * @param {WebChartTextSymbol | undefined} titleSymbol The title symbol.
      */
-    setTitleSymbol(newTitleSymbol: WebChartTextSymbol | undefined): void;
+    setTitleSymbol(titleSymbol: WebChartTextSymbol | undefined): void;
+    /**
+     * Gets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
+     * @returns {WebChartTextSymbol | undefined}
+     */
+    getSubtitleSymbol(): WebChartTextSymbol | undefined;
+    /**
+     * Sets the subtitle text symbol. Contains styling information such as font, color, and symbol style.
+     * @param {WebChartTextSymbol | undefined} subtitleSymbol The title symbol.
+     */
+    setSubtitleSymbol(subtitleSymbol: WebChartTextSymbol | undefined): void;
     /**
      * Gets the description text symbol. Contains styling information such as font, color, and symbol style.
      * @returns {WebChartTextSymbol | undefined}
@@ -170,9 +219,9 @@ export declare abstract class ChartModel extends EventTarget {
     getDescriptionSymbol(): WebChartTextSymbol | undefined;
     /**
      * Sets the description text symbol. Contains styling information such as font, color, and symbol style.
-     * @param {WebChartTextSymbol | undefined} newDescriptionSymbol - The new description symbol.
+     * @param {WebChartTextSymbol | undefined} descriptionSymbol The description symbol.
      */
-    setDescriptionSymbol(newDescriptionSymbol: WebChartTextSymbol | undefined): void;
+    setDescriptionSymbol(descriptionSymbol: WebChartTextSymbol | undefined): void;
     /**
      * Gets the background color of the chart.
      * @returns {Color | undefined}
@@ -180,9 +229,9 @@ export declare abstract class ChartModel extends EventTarget {
     getBackgroundColor(): Color | undefined;
     /**
      * Sets the background color of the chart.
-     * @param {Color | undefined} newBackgroundColor - The new background color.
+     * @param {Color | undefined} backgroundColor The background color.
      */
-    setBackgroundColor(newBackgroundColor: Color | undefined): void;
+    setBackgroundColor(backgroundColor: Color | undefined): void;
     /**
      * Gets the visibility of a series.
      * @param seriesIndex The series index
@@ -203,7 +252,7 @@ export declare abstract class ChartModel extends EventTarget {
      *
      * If the series index is out of bounds, this function will return `undefined`.
      *
-     * @param {number} seriesIndex
+     * @param {number} seriesIndex The index of the series.
      * @returns {string | undefined}
      */
     getSeriesId(seriesIndex: number): string | undefined;
@@ -228,17 +277,21 @@ export declare abstract class ChartModel extends EventTarget {
     getChartSubType(): ChartSubType;
     /**
      * Sets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
-     * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
      *
-     * @returns boolean - The fetch NULL values.
+     * @param fetchNULLValues Whether to fetch `null` values.
      */
     setFetchNULLValues(fetchNULLValues: boolean): void;
     /**
      * Gets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
      *
-     * @returns boolean - The fetch NULL values.
+     * @returns {boolean} Boolean value indicates whether NULL values will be fetched.
      */
     getFetchNULLValues(): boolean;
+    /**
+     * Gets the split-by values for the chart.
+     * @returns {string[]}
+     */
+    getSplitByValues(): string[];
     /**
      * Emits a config update event.
      * @category Protected
@@ -256,5 +309,5 @@ export declare abstract class ChartModel extends EventTarget {
      * @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 SupportedChartSeries>(params: ModelParams<ChartConfig<T>>): Promise<void>;
+    protected loadConfigFromLayer<T extends ModelTypes>(params: ModelParams<ChartConfig<T>>): Promise<void>;
 }

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

@@ -1,15 +1,13 @@
-import { ChartConfig } from '@arcgis/charts-shared-utils';
+import { ChartConfig } from '../../../utils';
 /**
- * Set whether to fetch `null` values for them to be counted or displayed as categories on the chart.
- * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
- *
- * @returns boolean - The fetch NULL values.
+ * Sets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
+ * @param fetchNULLValues Whether to fetch `null` values.
+ * @param config The chart config.
  */
 export declare const setFetchNULLValues: (fetchNULLValues: boolean, config: ChartConfig) => void;
 /**
- * Get whether to fetch `null` values for them to be counted or displayed as categories on the chart.
- * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
- *
- * @returns boolean - The fetch NULL values.
+ * Gets whether to fetch `null` values for them to be counted or displayed as categories on the chart.
+ * @param config The chart config.
+ * @returns {boolean} Boolean value indicates whether NULL values will be fetched.
  */
 export declare const getFetchNULLValues: (config: ChartConfig) => boolean;