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

package/dist/index.js

@@ -16,7 +16,7 @@ import { B as qo, a as Go, C as Qo, H as wo, L as Uo, P as zo, S as _o } from ".
 import { g as Yo, s as Zo } from "./chunks/runtime.js";
 /*! 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.90 */
+v5.0.0-next.92 */
 function v(a) {
   let o;
   switch (a.length) {

package/dist/interfaces.d.ts

@@ -136,30 +136,24 @@ 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;
     /**
      * Locale used for formatting numbers in the CSV.
      * This affects how numbers are formatted, such as decimal and thousands separators.
      * If not provided, the default locale will be used.
-     * @default "en"
-     *
      * "ar", "ar-u-nu-latn", "bs", "bg", "ca", "cs", "da", "de", "el", "en", "en-US", "es", "et", "fi", "fr", "he", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "no", "nl", "pl", "pt-BR", "pt-PT", "ro", "ru", "sr", "sl", "sk", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-HK", "zh-TW"
      */
     locale?: SupportedLocale;

package/dist/json-schema/index.d.ts

@@ -5006,11 +5006,11 @@ export namespace WebChartJSONSchemas {
             description: string;
             title: string;
         };
-        "Omit<(structure-1066060463-55283-56936-1066060463-55211-56937-1066060463-51231-56939-1066060463-0-59657|undefined)1405062998,(\"data\"|\"orderByFields\")>": {
+        "Omit<(structure-1066060463-55298-56951-1066060463-55226-56952-1066060463-51246-56954-1066060463-0-59672|undefined)1405062998,(\"data\"|\"orderByFields\")>": {
             $ref: string;
             title: string;
         };
-        "Pick<(structure-1066060463-55283-56936-1066060463-55211-56937-1066060463-51231-56939-1066060463-0-59657|undefined)1405062998,Exclude<(\"series\"|\"data\"|\"orderByFields\"),(\"data\"|\"orderByFields\")>>": {
+        "Pick<(structure-1066060463-55298-56951-1066060463-55226-56952-1066060463-51246-56954-1066060463-0-59672|undefined)1405062998,Exclude<(\"series\"|\"data\"|\"orderByFields\"),(\"data\"|\"orderByFields\")>>": {
             type: string;
             properties: {
                 series: {

package/dist/loader.js

@@ -2,7 +2,7 @@ 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.90 */
+v5.0.0-next.92 */
 const o = t(e, {
   "arcgis-chart": [() => import("./components/arcgis-chart/customElement.js"), "actionMode,allowUsingObjectIdStat,autoDestroyDisabled,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:,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"],

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

@@ -14,26 +14,28 @@ 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;
     /**
@@ -47,7 +49,6 @@ export declare class BarChartModel extends SerialChartModel {
     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

@@ -12,22 +12,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 +54,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 newDataFilter The new data filter.
+     *
+     * @param newDataFilter - The new data filter.
      */
     setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
     /**
@@ -99,7 +95,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 +107,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 +121,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,20 +186,23 @@ 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;
     /**
@@ -215,8 +211,6 @@ export declare class BoxPlotModel extends ChartModel {
     generateChartTitle(): string;
     /**
      * Generate the proper x-axis title given the current config.
-     *
-     * @returns {string}
      */
     generateXAxisTitle(): string;
     /**
@@ -229,7 +223,6 @@ export declare class BoxPlotModel extends ChartModel {
     resetSeriesStyling(): void;
     /**
      * Returns whether the series styling is able to be reset.
-     * @returns {boolean}
      */
     resetAvailable(): boolean;
 }

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.d.ts

@@ -17,12 +17,11 @@ export declare abstract class ChartModel extends EventTarget {
      */
     protected commonStrings: CommonStrings;
     /**
-     * Chart Type
+     * Chart type.
      */
     protected _chartType: ChartTypes;
     /**
      * List of setters (either props or methods) that have been changed and will require an async series rebuild.
-     * @category Protected
      */
     protected dirtyAsyncSetters: string[];
     /**
@@ -35,18 +34,19 @@ export declare abstract class ChartModel extends EventTarget {
     protected pendingUpdates: number;
     /**
      * Function that resolves the setup promise.
-     * @category Protected
      */
     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.
+     *
+     * @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>;
     /**
      * Checks if the current chart model is for the same chart as another chart model.
-     * @param otherModel The other chart model to compare to.
+     *
+     * @param otherModel - The other chart model to compare to.
      */
     isSameChartAs(otherModel: ChartModel | undefined): boolean;
     /**
@@ -92,13 +92,11 @@ export declare abstract class ChartModel extends EventTarget {
     get version(): string | undefined;
     /**
      * The chart title text.
-     * @type {string}
      */
     get titleText(): string;
     set titleText(title: string);
     /**
      * The chart subtitle text.
-     * @returns {string}
      */
     get subtitleText(): string;
     set subtitleText(subtitle: string);
@@ -158,27 +156,28 @@ export declare abstract class ChartModel extends EventTarget {
     set backgroundColor(backgroundColor: Color | undefined);
     /**
      * Gets the visibility of a series.
+     *
      * @param seriesIndex The series index
-     * @returns {boolean}
      */
     getSeriesVisibility(seriesIndex: number): boolean;
     /**
      * Sets the visibility of a series.
-     * @param {LegendItemVisibility} props - Visibility options for the series.
+     *
+     * @param props - Visibility options for the series.
      */
     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 seriesIndex The index of the series.
+     * @param seriesIndex - The index of the series.
      */
     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 seriesId The ID of the series.
+     * @param seriesId - The ID of the series.
      */
     getSeriesIndex(seriesId: string): number | undefined;
     /**
@@ -194,15 +193,14 @@ export declare abstract class ChartModel extends EventTarget {
      *
      * If the series index is out of bounds or the series list is empty, this function will return `undefined`.
      *
-     * @param {number} seriesIndex The index of the series to retrieve the value format for.
-     * @returns {NumberFormatOptions | undefined}
+     * @param seriesIndex - The index of the series to retrieve the value format for.
      */
     getDataTooltipValueFormat(seriesIndex: number): NumberFormatOptions | undefined;
     /**
      * Sets the data tooltip value format for a series.
      *
-     * @param {number} seriesIndex The index of the series to set the value format for.
-     * @param {NumberFormatOptions | undefined} valueFormat The value format to set.
+     * @param seriesIndex - The index of the series to set the value format for.
+     * @param valueFormat - The value format to set.
      */
     setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void;
     /**
@@ -216,12 +214,12 @@ export declare abstract class ChartModel extends EventTarget {
     get splitByValues(): string[];
     /**
      * Gets the data filter for the bar chart.
-     * @returns {WebChartDataFilters | undefined}
      */
     getDataFilters(): WebChartDataFilters | undefined;
     /**
      * Sets the data filter for the chart.
-     * @param newDataFilters The new data filter.
+     *
+     * @param newDataFilters - The new data filter.
      */
     setDataFilters(newDataFilters: WebChartDataFilters | undefined): Promise<void>;
     /**
@@ -234,9 +232,10 @@ export declare abstract class ChartModel extends EventTarget {
     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.
+     *
+     * @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>;
     /**
@@ -249,7 +248,8 @@ export declare abstract class ChartModel extends EventTarget {
     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.
+     *
+     * @param setter - The setter callback to call after setup or async config update is finished.
      */
     protected guardSetterFromAsyncOverwrite: (setter: (() => Promise<void>) | (() => void)) => Promise<void>;
 }

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

@@ -2,31 +2,36 @@ import { WebChartDataFilters } from '../../../spec';
 import { ChartConfig } from '../../../utils';
 /**
  * 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.
+ *
+ * @param fetchNULLValues - Whether to fetch `null` values.
+ * @param config - The chart config.
  */
 export declare const setFetchNULLValues: (fetchNULLValues: boolean, config: ChartConfig) => void;
 /**
  * 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.
+ *
+ * @param config - The chart config.
+ * @returns Boolean value indicates whether NULL values will be fetched.
  */
 export declare const getFetchNULLValues: (config: ChartConfig) => boolean;
 /**
  * Gets the split by values from the chart config.
- * @param config The chart config.
- * @returns {string[]} An array of split by values.
+ *
+ * @param config - The chart config.
+ * @returns An array of split by values.
  */
 export declare const getSplitByValues: (config: ChartConfig) => string[];
 /**
  * Get the data filter from the config.
- * @param  {ChartConfig} config - The chart config.
- * @returns WebChartDataFilters | undefined - The data filter.
+ *
+ * @param config - The chart config.
+ * @returns The data filter.
  */
 export declare const getDataFilters: (config: ChartConfig) => WebChartDataFilters | undefined;
 /**
  * Set the data filter in the config.
- * @param  {WebChartDataFilters | undefined} dataFilter - The data filter.
- * @param  {ChartConfig} config - The chart config.
+ *
+ * @param dataFilter - The data filter.
+ * @param config - The chart config.
  */
 export declare const setDataFilters: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig) => void;