@arcgis/charts-components 4.33.0-next.95 → 4.33.0-next.96

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

@@ -0,0 +1,244 @@
+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 { ModelParams } from '../interfaces/chart-interfaces';
+import { LayerInfo, 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 _chartType: XYChartTypes;
+    protected layerInfo: LayerInfo;
+    /**
+     * Common strings used in the model.
+     * @category Private
+     */
+    private commonStrings;
+    /**
+     * 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<WebChartBoxPlotSeries>>): Promise<void>;
+    /**
+     * Gets the category field for the box plot.
+     * @returns {string}
+     */
+    getCategory(): string;
+    /**
+     * Sets the category field for the box plot.
+     * @param {string} newCategory The new category field.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setCategory(newCategory: string): Promise<void>;
+    /**
+     * Gets the list of the category values for the chart.
+     * @returns {string[]}
+     */
+    getCustomSortValues(): Promise<string[]>;
+    /**
+     * Gets the numeric fields array for the box plot.
+     * @returns {string[]}
+     */
+    getNumericFields(): string[];
+    /**
+     * Sets the numeric field or numeric fields array for the box plot.
+     * @param {string[] | string} newNumericFields The new numeric field or numeric fields array.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setNumericFields(newNumericFields: string[] | string): Promise<void>;
+    /**
+     * Gets the split-by field for the box plot.
+     * @returns {string}
+     */
+    getSplitByField(): string;
+    /**
+     * Sets the split-by field for the box plot.
+     * @param {string} newSplitByField The new split-by field.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setSplitByField(newSplitByField: string): Promise<void>;
+    /**
+     * Gets whether outliers are shown.
+     * @returns {boolean}
+     */
+    getShowOutliers(): boolean;
+    /**
+     * Sets whether outliers are shown.
+     * @param {boolean} newShowOutliersState The new show outliers state.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setShowOutliers(newShowOutliersState: boolean): Promise<void>;
+    /**
+     * Gets whether values are standardized as z-scores.
+     * @returns {boolean}
+     */
+    getStandardizeValues(): boolean;
+    /**
+     * Sets whether values are standardized as z-scores.
+     * @param {boolean} newStandardizeValuesState The new standardize values state.
+     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     */
+    setStandardizeValues(newStandardizeValuesState: boolean): Promise<void>;
+    /**
+     * 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.
+     */
+    setSortOrder(newSortOrder: BoxPlotDataSortingKinds, orderByList?: string[]): void;
+    /**
+     * Gets the list of category's values for custom sort
+     * @returns {string[]}
+     */
+    getOrderByList(): string[];
+    /**
+     * Sets the list of category's values for custom sort
+     * @param {string[]} newOrderByList The new list of category's values
+     */
+    setOrderByList(newOrderByList: string[]): void;
+    /**
+     * Updates the series based on the layer filter.
+     * @async **This method is `async` and must be awaited for the changes to take effect.*
+     */
+    updateSeriesFromLayerFilter(): Promise<void>;
+    /**
+     * Gets the data filter for the bar chart.
+     * @returns {WebChartDataFilters | undefined}
+     */
+    getDataFilter(): WebChartDataFilters | undefined;
+    /**
+     * Sets the data filter for the bar chart.
+     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     */
+    setDataFilter(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
+    /**
+     * Gets whether mean lines are shown.
+     * @returns {boolean | undefined}
+     */
+    getShowMeanLines(): boolean | undefined;
+    /**
+     * Sets whether mean lines are shown.
+     * @param {boolean | undefined} newShowMeanLines The new show mean lines state.
+     */
+    setShowMeanLines(newShowMeanLines: boolean | undefined): Promise<void>;
+    /**
+     * Gets the color of the boxes when showing mean lines. Only applicable when mean lines are shown.
+     * @returns {Color | undefined}
+     */
+    getMeanLinesBoxColor(): Color | undefined;
+    /**
+     * Sets the color of the boxes when showing mean lines. Only applicable when mean lines are shown.
+     * @param {Color | undefined} newColor The new color.
+     */
+    setMeanLinesBoxColor(newColor: Color | undefined): void;
+    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    /**
+     * 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}
+     */
+    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.
+     */
+    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}
+     */
+    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.
+     */
+    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.**
+     *
+     * @param {number} seriesIndex The index of the series.
+     * @returns {RESTSimpleLineSymbolStyle | undefined}
+     */
+    getSeriesLineStyle(seriesIndex: number): RESTSimpleLineSymbolStyle | undefined;
+    /**
+     * Sets the line style of the series based on the series index.
+     *
+     * **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.
+     */
+    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.**
+     *
+     * @param {number} seriesIndex The index of the series.
+     * @returns {number | undefined}
+     */
+    getSeriesLineWidth(seriesIndex: number): number | undefined;
+    /**
+     * Sets the line width of the series based on the series index.
+     *
+     * **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.
+     */
+    setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
+    /**
+     * Gets the order of the series array by returning an array of series ids.
+     * @returns {string[]}
+     */
+    getOrderOfSeries(): string[];
+    /**
+     * Sets the order of the series array by providing an array of series ids.
+     * @param {string[]} newOrder The new order of the series array.
+     */
+    setOrderOfSeries(newOrder: string[]): void;
+    /**
+     * 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.
+     */
+    moveSeries(fromIndex: number, toIndex: number): void;
+    /**
+     * Get 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.
+     * @param config - config object
+     */
+    getBoxPlotSeriesIndexWhenMeanLinesShown(): 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.
+     */
+    moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
+    /**
+     * Resets the series styling to the default styling.
+     */
+    resetSeriesStyling(): void;
+    /**
+     * Returns whether the series styling is able to be reset.
+     * @returns {boolean}
+     */
+    resetAvailable(): boolean;
+}
+export interface BoxPlotModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithRotation, ModelWithDataLabels, ModelWithYGuides {
+}

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

@@ -0,0 +1,124 @@
+import { BoxPlotConfig, ChartConfig } from '@arcgis/charts-shared-utils';
+import { Color, WebChartBoxPlotSeries, WebChartDataFilters, WebChartLineChartSeries } from '@arcgis/charts-spec';
+import { LayerInfo, BoxPlotDataSortingKinds } from '../../interfaces/common';
+/**
+ * Gets the category field.
+ */
+export declare const getCategory: (config: BoxPlotConfig) => string;
+/**
+ * Gets the split-by field.
+ */
+export declare const getSplitByField: (config: BoxPlotConfig) => string;
+/**
+ * get 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
+ */
+export declare const buildNewSeries: (props: {
+    splitByField: string;
+    numericFields: string[];
+    category: string;
+    config: BoxPlotConfig;
+    layerInfo: LayerInfo;
+}) => Promise<void>;
+/**
+ * Gets whether the values are standardized.
+ */
+export declare const getStandardizeValues: (config: BoxPlotConfig) => boolean;
+/**
+ * Sets the category field by updating the config accordingly.
+ */
+export declare const setCategory: (newCategory: string, config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * set the numeric fields in the config object
+ * @param newNumericFields - new numeric fields
+ * @param config - box plot config object
+ * @param layerInfo - layer info
+ */
+export declare const setNumericFields: (newNumericFields: string[], config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * Gets the default series name.
+ */
+export declare const getDefaultSeriesName: (series: WebChartBoxPlotSeries | WebChartLineChartSeries, splitByField: string, layerInfo: LayerInfo, commonStrings: typeof import("../../t9n/common/messages.en.json")) => string;
+/**
+ * Sets the split-by field by updating the config accordingly.
+ */
+export declare const setSplitByField: (newSplitByField: string, config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * Gets whether the outliers are shown.
+ * @param config
+ */
+export declare const getShowOutliers: (config: BoxPlotConfig) => boolean;
+/**
+ * Sets whether the outliers are shown.
+ * @param newShowOutliers
+ * @param config
+ * @param layerInfo
+ */
+export declare const setShowOutliers: (newShowOutliers: boolean, config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * Sets whether the values are standardized.
+ */
+export declare const setStandardizeValues: (newStandardizeValues: boolean, config: BoxPlotConfig, layerInfo: LayerInfo) => Promise<void>;
+/**
+ * Gets the sort order.
+ */
+export declare const getSortOrderKind: (config: BoxPlotConfig) => BoxPlotDataSortingKinds;
+/**
+ * Sets the sort order.
+ */
+export declare const setSortOrderKind: (newSortOrderKind: BoxPlotDataSortingKinds, config: ChartConfig<WebChartBoxPlotSeries>, orderByList?: string[]) => void;
+/**
+ * Gets whether the mean lines are shown.
+ * @param config
+ */
+export declare const getShowMeanLines: (config: BoxPlotConfig) => boolean;
+/**
+ * Sets whether the mean lines are shown. Rebuilds the series array.
+ * @param newShowMeanLines Whether to show the mean lines
+ * @param config The config to update
+ * @param previousMeanLinesBoxColor The previous color of the boxes when mean lines were enabled
+ */
+export declare const setShowMeanLines: (newShowMeanLines: boolean | undefined, config: BoxPlotConfig, previousMeanLinesBoxColor?: Color) => Promise<{
+    previousMeanLinesBoxColor: Color | undefined;
+}>;
+/**
+ * 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.
+ *
+ * @returns string[] - The order by list.
+ */
+export declare const getOrderByList: (config: ChartConfig<WebChartBoxPlotSeries>) => 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.
+ */
+export declare const setOrderByList: (values: string[], config: ChartConfig<WebChartBoxPlotSeries>) => void;
+/**
+ * Get the data filter from the config.
+ * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
+ * @returns WebChartDataFilters | undefined - The data filter.
+ */
+export declare const getDataFilter: (config: ChartConfig<WebChartBoxPlotSeries>) => WebChartDataFilters | undefined;
+/**
+ * Set the data filter in the config.
+ * @param  {WebChartDataFilters | undefined} dataFilter - The data filter.
+ * @param  {ChartConfig<WebChartBarChartSeries} config - The chart config.
+ */
+export declare const setDataFilter: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig<WebChartBoxPlotSeries>) => void;
+/**
+ * Get the custom sort values from the config.
+ * @param  {ChartConfig<WebChartBarChartSeries} 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[]>;

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

@@ -0,0 +1,66 @@
+import { Color } from '@arcgis/charts-spec';
+import { BoxPlotConfig } from '@arcgis/charts-shared-utils';
+/**
+ * get series name of the given series from the in config object using series index
+ * @param seriesIndex - index of series in series array
+ * @param config - config object
+ */
+export declare const getName: (seriesIndex: number, config: BoxPlotConfig) => string | undefined;
+/**
+ * set series name of the given series in the series array in config object using series index
+ * @param newName - new name to be set
+ * @param seriesIndex - index of series in series array
+ * @param config - config object
+ */
+export declare const setName: (newName: string, seriesIndex: number, config: BoxPlotConfig) => void;
+/**
+ * get series color of the given series from the series array in config object using series index
+ * @param seriesIndex - index of series in series array
+ * @param config - config object
+ */
+export declare const getColor: (seriesIndex: number, config: BoxPlotConfig) => Color | undefined;
+/**
+ * get color of the box plot series from config object used when show mean is true
+ * @param config
+ */
+export declare const getMeanLinesBoxColor: (config: BoxPlotConfig) => Color | undefined;
+/**
+ * set color of the box plot series in config object used when show mean is true
+ * @param newColor - new color to be set
+ * @param config - config object
+ */
+export declare const setMeanLinesBoxColor: (newColor: Color | undefined, config: BoxPlotConfig) => void;
+/**
+ * set series color of the given series in the series array in config object using series index
+ * @param newColor - new color to be set
+ * @param seriesIndex - index of series in series array
+ * @param config - config object
+ */
+export declare const setColor: (newColor: Color | undefined, seriesIndex: number, config: BoxPlotConfig) => void;
+/**
+ * get the order of series from the series array in config object
+ * @param config - config object
+ */
+export declare const getSeriesOrder: (config: BoxPlotConfig) => string[];
+/**
+ * set the order of series in the series array in config object using new order of series
+ * @param newSeriesOrder - new order of series to be set
+ * @param config - config object
+ * @returns void
+ */
+export declare const setSeriesOrder: (newSeriesOrder: string[], config: BoxPlotConfig) => void;
+/**
+ * Move a series in-place from one index to another in the series array in box plot config
+ * @param fromIndex - index of the series to be moved
+ * @param toIndex - index where the series should be moved
+ * @param config - box plot config
+ * @returns void
+ */
+export declare const moveSeries: (fromIndex: number, toIndex: number, config: BoxPlotConfig) => void;
+/**
+ * Get 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.
+ * @param config - config object
+ */
+export declare const getBoxPlotSeriesIndexWhenMeanLinesShown: (config: BoxPlotConfig) => number;

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

@@ -0,0 +1,260 @@
+import { ChartConfig, ChartSubType, ChartTypes, SupportedChartSeries } from '@arcgis/charts-shared-utils';
+import { Color, LegendItemVisibility, SupportedLayer, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { ModelParams } from '../interfaces/chart-interfaces';
+import { LayerInfo } from '../interfaces/common';
+export declare abstract class ChartModel extends EventTarget {
+    /**
+     * Current configuration used for the chart.
+     * @category Protected
+     */
+    protected _config: ChartConfig;
+    /**
+     * Grouping of layer-related properties to be passed to external function more compactly.
+     * @category Protected
+     */
+    protected layerInfo: LayerInfo | undefined;
+    /**
+     * Chart Type
+     * @category Protected
+     */
+    protected _chartType: ChartTypes;
+    /**
+     * Function that resolves the setup promise.
+     * @category Protected
+     */
+    protected resolveSetup: () => void;
+    /**
+     * Data store object that can be used to store any data needed for the chart.
+     */
+    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.
+     * @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.
+     * @returns {boolean}
+     */
+    isSameChartAs(otherModel: ChartModel | undefined): boolean;
+    /**
+     * Gets the current chart configuration object.
+     * @returns {ChartConfig}
+     */
+    getConfig(): ChartConfig;
+    /**
+     * Sets the chart configuration object.
+     * @param {ChartConfig} newConfig - The new configuration object.
+     */
+    setConfig(newConfig: ChartConfig): void;
+    /**
+     * Gets the chart type.
+     * @returns {ChartTypes}
+     */
+    getChartType(): typeof this._chartType;
+    /**
+     * Gets the associated layer.
+     * @returns {SupportedLayer | undefined}
+     */
+    getLayer(): SupportedLayer | undefined;
+    /**
+     * Gets the chart id.
+     * @returns {string | undefined}
+     */
+    getChartId(): string | undefined;
+    /**
+     * Sets the chart id.
+     * @param {string} newId
+     */
+    setChartId(newId: 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 chart title text.
+     * @returns {string}
+     */
+    getTitleText(): string;
+    /**
+     * Sets the chart title text.
+     * @param {string} newTitle - The new title text.
+     */
+    setTitleText(newTitle: string): void;
+    /**
+     * Gets the chart subtitle text.
+     * @returns {string}
+     */
+    getSubtitleText(): string;
+    /**
+     * Sets the chart subtitle text.
+     * @param {string} newSubTitle - The new subtitle text.
+     */
+    setSubtitleText(newSubTitle: string): void;
+    /**
+     * Gets the chart description text.
+     * @returns {string}
+     */
+    getDescriptionText(): string;
+    /**
+     * Sets the chart description text.
+     * @param {string} newDescription - The new description text.
+     */
+    setDescriptionText(newDescription: string): void;
+    /**
+     * Gets whether the chart title is visible or not.
+     *
+     * `true`: Chart title is visible.
+     *
+     * `false`: Chart title is hidden.
+     *
+     * @returns {boolean}
+     *
+     * **Note: Even if the title is visible, it may not be displayed if the title text is empty.**
+     */
+    getChartTitleVisibility(): boolean;
+    /**
+     * Sets whether the chart title is visible or not.
+     *
+     * `true`: Show chart title.
+     *
+     * `false`: Hide chart title.
+     *
+     * @param {boolean} newVisibility - The new 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;
+    /**
+     * Gets whether the chart description is visible or not.
+     *
+     * `true`: Description is visible.
+     *
+     * `false`: Description is hidden.
+     *
+     * @returns {boolean}
+     *
+     * **Note: Even if the description is visible, it may not be displayed if the description text is empty.**
+     */
+    getDescriptionVisibility(): boolean;
+    /**
+     * Sets whether the chart description is visible or not.
+     *
+     * `true`: Show description.
+     *
+     * `false`: Hide description.
+     *
+     * @param {boolean} newVisibility - The new 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;
+    /**
+     * Gets the title text symbol. Contains styling information such as font, color, and symbol style.
+     * @returns {WebChartTextSymbol | undefined}
+     */
+    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.
+     */
+    setTitleSymbol(newTitleSymbol: WebChartTextSymbol | undefined): void;
+    /**
+     * Gets the description text symbol. Contains styling information such as font, color, and symbol style.
+     * @returns {WebChartTextSymbol | undefined}
+     */
+    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.
+     */
+    setDescriptionSymbol(newDescriptionSymbol: WebChartTextSymbol | undefined): void;
+    /**
+     * Gets the background color of the chart.
+     * @returns {Color | undefined}
+     */
+    getBackgroundColor(): Color | undefined;
+    /**
+     * Sets the background color of the chart.
+     * @param {Color | undefined} newBackgroundColor - The new background color.
+     */
+    setBackgroundColor(newBackgroundColor: Color | undefined): void;
+    /**
+     * Gets the visibility of a series.
+     * @param seriesIndex The series index
+     * @returns {boolean}
+     */
+    getSeriesVisibility(seriesIndex: number): boolean;
+    /**
+     * Sets the visibility of a series.
+     * @param {boolean} props.visible
+     * @param {string} props.seriesId
+     * @param {OverlayTerms} props.overlayType
+     * @param {string} props.sliceId
+     * @param {WebChartDataItem} props.sliceData
+     */
+    setSeriesVisibility(props: LegendItemVisibility): void;
+    /**
+     * Gets the series ID for a given series index.
+     *
+     * If the series index is out of bounds, this function will return `undefined`.
+     *
+     * @param {number} seriesIndex
+     * @returns {string | undefined}
+     */
+    getSeriesId(seriesIndex: number): string | undefined;
+    /**
+     * Gets the series index for a given series ID.
+     *
+     * If the series ID is not found, this function will return `undefined`.
+     *
+     * @param {string} seriesId
+     * @returns {number | undefined}
+     */
+    getSeriesIndex(seriesId: string): number | undefined;
+    /**
+     * Gets the length of the series array.
+     * @returns {number}
+     */
+    getSeriesLength(): number;
+    /**
+     * Gets the chart sub type of the series.
+     * @returns {ChartSubType}
+     */
+    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.
+     */
+    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.
+     */
+    getFetchNULLValues(): boolean;
+    /**
+     * Emits a config update event.
+     * @category Protected
+     */
+    protected emitConfigUpdate(functionCalled: string): void;
+    /**
+     * A function that generates the default config object when creating a new chart.
+     * @category Protected
+     */
+    protected abstract generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    /**
+     * A function that loads the config based on the provided props.
+     * @category Protected
+     * @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 SupportedChartSeries>(params: ModelParams<ChartConfig<T>>): Promise<void>;
+}