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

package/dist/model/properties/title/title-visibility.d.ts

@@ -0,0 +1,26 @@
+import { ChartConfig } from '../../../utils';
+import { ChartModelBase } from '../../chart-model/chart-model-base';
+/**
+ * Gets whether the chart title is visible.
+ */
+export declare const getChartTitleVisibility: (config: ChartConfig) => boolean;
+/**
+ * Sets whether the chart title is visible.
+ */
+export declare const setChartTitleVisibility: (visibility: boolean, config: ChartConfig) => void;
+/**
+ * Adds support for working with chart title visibility.
+ */
+export declare abstract class WithChartTitleVisibility extends ChartModelBase {
+    /**
+     * Whether or not the chart title is visible.
+     *
+     * `true`: Chart title is visible.
+     *
+     * `false`: Chart title is hidden.
+     *
+     * **Note:** Even if the title is visible, it may not be displayed if the title text is empty.
+     */
+    get chartTitleVisibility(): boolean;
+    set chartTitleVisibility(visibility: boolean);
+}

package/dist/model/properties/version.d.ts

@@ -0,0 +1,15 @@
+import { ChartConfig } from '../../utils/types';
+import { ChartModelBase } from '../chart-model/chart-model-base';
+/**
+ * Gets the version of the chart configuration.
+ */
+export declare const getVersion: (config: ChartConfig) => string | undefined;
+/**
+ * Adds getter support for the chart version.
+ */
+export declare abstract class WithVersion extends ChartModelBase {
+    /**
+     * The version of the chart configuration.
+     */
+    get version(): string | undefined;
+}

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

@@ -2,8 +2,10 @@ import { WebChart, WebChartRadarChartSeries } from '../../spec';
 import { ChartConfig } from '../../utils';
 import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
 import { ModelParams } from '../interfaces/chart-interfaces';
-import { ModelWithBaselineStacking, ModelWithLineMarkerStyling } from '../mixins';
+import { ModelWithLineMarkerStyling } from '../mixins';
 import { LayerInfo, ModelTypes } from '../interfaces/common';
+import { MixinInstances } from '../shared/utils';
+import { WithNegativeValuesStackedToBaseline } from '../properties/series/negative-values-stacked-to-baseline';
 export declare class RadarChartModel extends SerialChartModel {
     /**
      * Current configuration used for the Radar chart.
@@ -11,7 +13,6 @@ export declare class RadarChartModel extends SerialChartModel {
     protected _config: ChartConfig<typeof ModelTypes.RadarChart, WebChart>;
     /**
      * Default series for the radar chart. Used in resetting the series styling.
-     * @category Protected
      */
     protected defaultSeries: WebChartRadarChartSeries | undefined;
     protected _chartType: "radarSeries";
@@ -20,7 +21,6 @@ export declare class RadarChartModel extends SerialChartModel {
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Initializes the default series for the radar chart. Used in resetting the series styling.
-     * @category Private
      */
     protected initDefaultSeries(): void;
     /**
@@ -29,9 +29,10 @@ export declare class RadarChartModel extends SerialChartModel {
     resetSeriesStyling(): void;
     /**
      * Returns whether the series styling is able to be reset.
-     * @returns {boolean}
      */
     resetAvailable(): boolean;
 }
-export interface RadarChartModel extends ModelWithBaselineStacking, ModelWithLineMarkerStyling {
+declare const radarChartMixins: readonly [typeof WithNegativeValuesStackedToBaseline, typeof ModelWithLineMarkerStyling];
+export interface RadarChartModel extends MixinInstances<typeof radarChartMixins> {
 }
+export {};

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

@@ -1,9 +1,21 @@
 import { ISimpleLineSymbol, ISimpleMarkerSymbol, WebChart, SizePolicy, ScatterplotOverlays } from '../../spec';
 import { ChartConfig, XYChartTypes } from '../../utils';
+import { MixinInstances } from '../shared/utils';
 import { ModelParams } from '../interfaces/chart-interfaces';
 import { LayerInfo, ModelTypes } from '../interfaces/common';
 import { ChartModel } from '../chart-model/chart-model';
-import { ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides, ModelWithLegend, ModelWithMultiAxes, ModelWithTooltips } from '../mixins';
+import { ModelWithXGuides, ModelWithYGuides, ModelWithLegend, ModelWithMultiAxes, ModelWithTooltips } from '../mixins';
+import { WithColorMatch } from '../properties/color-match';
+import { WithDataLabelsVisibility } from '../properties/data-labels/data-labels-visibility';
+import { WithDataLabelsSymbol } from '../properties/data-labels/data-labels-symbol';
+import { WithAxisLabelsSymbol } from '../properties/axes/axis-labels-symbol';
+import { WithAxisLinesSymbol } from '../properties/axes/axis-lines-symbol';
+import { WithXBounds } from '../properties/axes/x-axis/x-bounds';
+import { WithXAxisLabelsVisibility } from '../properties/axes/x-axis/x-axis-labels-visibility';
+import { WithXAxisTitleSymbol } from '../properties/axes/x-axis/x-axis-title-symbol';
+import { WithXAxisTitleText } from '../properties/axes/x-axis/x-axis-title-text';
+import { WithXAxisTitleVisibility } from '../properties/axes/x-axis/x-axis-title-visibility';
+import { WithGenerateXAxisTitle } from '../properties/axes/x-axis/generate-x-axis-title';
 export declare class ScatterplotModel extends ChartModel {
     /**
      * Current configuration used for the scatterplot.
@@ -56,23 +68,15 @@ export declare class ScatterplotModel extends ChartModel {
     set additionalTooltipField(fields: string[] | string | undefined);
     /**
      * Generate the proper chart title given the current config.
-     *
-     * @returns {string}
      */
     generateChartTitle(): string;
-    /**
-     * Generate the proper x-axis title given the current config.
-     *
-     * @returns {string}
-     */
-    generateXAxisTitle(): string;
     /**
      * Generate the proper y-axis title given the current config.
-     *
-     * @returns {string}
      */
     generateYAxisTitle(): string;
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
 }
-export interface ScatterplotModel extends ModelWithMultiAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides {
+declare const scatterplotMixins: readonly [typeof ModelWithMultiAxes, typeof ModelWithLegend, typeof ModelWithTooltips, typeof WithColorMatch, typeof WithDataLabelsVisibility, typeof WithDataLabelsSymbol, typeof ModelWithXGuides, typeof ModelWithYGuides, typeof WithXAxisTitleText, typeof WithXAxisLabelsVisibility, typeof WithXAxisTitleVisibility, typeof WithXBounds, typeof WithXAxisTitleSymbol, typeof WithAxisLabelsSymbol, typeof WithAxisLinesSymbol, typeof WithGenerateXAxisTitle];
+export interface ScatterplotModel extends MixinInstances<typeof scatterplotMixins> {
 }
+export {};

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

@@ -93,24 +93,28 @@ export declare const getSizePolicy: (config: ScatterplotConfig) => SizePolicy |
 export declare const setSizePolicy: (sizePolicy: SizePolicy | undefined, config: ScatterplotConfig) => void;
 /**
  * Gets the chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param config - The scatterplot config
  */
 export declare const getSeriesOverlays: (config: ScatterplotConfig) => ScatterplotOverlays | undefined;
 /**
  * Sets the chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
- * @param {ScatterplotOverlays} overlays The overlays
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param overlays - The overlays
+ * @param config - The scatterplot config
  */
 export declare const setSeriesOverlays: (overlays: ScatterplotOverlays, config: ScatterplotConfig) => void;
 /**
  * Gets the additional tooltip display fields from the config.
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param config - The scatterplot config
  */
 export declare const getAdditionalTooltipField: (config: ScatterplotConfig) => string[];
 /**
  * Sets the additional tooltip display fields in the config.
- * @param {string | string[]} fields The tooltip display fields
- * @param {ScatterplotConfig} config The scatterplot config
+ *
+ * @param fields - The tooltip display fields
+ * @param config - The scatterplot config
  *
  */
 export declare const setAdditionalTooltipField: (fields: string[] | string | undefined, config: ScatterplotConfig) => void;

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

@@ -2,12 +2,24 @@ import { SerialChartTypes } from '../../utils';
 import { ChartModel } from '../chart-model/chart-model';
 import { Color, WebChartDataFilters, WebChartNullCategory, WebChartStackedKinds, WebChartStatisticType } from '../../spec';
 import { SerialChartConfig } from '../interfaces/chart-interfaces';
-import { SerialChartDataSortingKinds } from '../interfaces/common';
-import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithTooltips, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithYGuides, ModelWithMultiAxes } from '../mixins';
+import { MixinInstances } from '../shared/utils';
+import { HeatChartDataSortingKinds, SerialChartDataSortingKinds } from '../interfaces/common';
+import { ModelWithLegend, ModelWithTooltips, ModelWithTemporalBinning, ModelWithXGuides, ModelWithYGuides, ModelWithMultiAxes } from '../mixins';
+import { WithColorMatch } from '../properties/color-match';
+import { WithRotatedState } from '../properties/rotated-state';
+import { WithDataLabelsVisibility } from '../properties/data-labels/data-labels-visibility';
+import { WithDataLabelsSymbol } from '../properties/data-labels/data-labels-symbol';
+import { WithAxisLabelsSymbol } from '../properties/axes/axis-labels-symbol';
+import { WithAxisLinesSymbol } from '../properties/axes/axis-lines-symbol';
+import { WithXBounds } from '../properties/axes/x-axis/x-bounds';
+import { WithXAxisLabelsVisibility } from '../properties/axes/x-axis/x-axis-labels-visibility';
+import { WithXAxisTitleSymbol } from '../properties/axes/x-axis/x-axis-title-symbol';
+import { WithXAxisTitleText } from '../properties/axes/x-axis/x-axis-title-text';
+import { WithXAxisTitleVisibility } from '../properties/axes/x-axis/x-axis-title-visibility';
+import { WithGenerateXAxisTitle } from '../properties/axes/x-axis/generate-x-axis-title';
 export declare abstract class SerialChartModel extends ChartModel {
     /**
      * Current chart type.
-     * @category Protected
      */
     protected _chartType: SerialChartTypes;
     /**
@@ -16,22 +28,18 @@ export declare abstract class SerialChartModel extends ChartModel {
     protected _config: SerialChartConfig;
     /**
      * Internal storage of the x-axis field for the chart.
-     * @category Protected
      */
     protected _xAxisField: string;
     /**
      * Internal storage of the aggregation type for the chart.
-     * @category Protected
      */
     protected _aggregationType: WebChartStatisticType;
     /**
      * 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[];
     /**
@@ -56,35 +64,36 @@ export declare abstract class SerialChartModel extends ChartModel {
     set numericFields(newNumericFields: string[] | string);
     /**
      * Gets whether the series should be assigned to the second value axis.
+     *
      * @param seriesIndex - The index of the series.
-     * @returns {boolean}
      */
     getAssignToSecondValueAxis(seriesIndex: number): boolean;
     /**
      * Sets whether the series should be assigned to the second value axis.
+     *
      * @param assign - The value for the setting.
      * @param seriesIndex - The index of the series.
      */
     setAssignToSecondValueAxis(assign: boolean, seriesIndex: number): void;
     /**
      * Gets the sort order for the bar chart.
-     * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
      */
-    getSortOrder(): SerialChartDataSortingKinds;
+    getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
     /**
      * Sets the sort order for the bar chart.
-     * @param {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc"}  newSortOrder The new sort order.
-     * @param {string[]} orderByList The list of category's values to order by.
+     *
+     * @param newSortOrder - The new sort order.
+     * @param orderByList - The list of category's values to order by.
      */
-    setSortOrder(newSortOrder: SerialChartDataSortingKinds, orderByList?: string[]): void;
+    setSortOrder(newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, orderByList?: string[]): void;
     /**
      * Gets the list of the category values for the chart.
-     * @returns {string[]}
      */
     getCustomSortValues(): Promise<string[]>;
     /**
      * Sets the data filter for the bar chart.
-     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     *
+     * @param newDataFilter - The new data filter.
      */
     setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
     /**
@@ -106,77 +115,79 @@ export declare abstract class SerialChartModel extends ChartModel {
     /**
      * 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} name The name for the series.
-     * @param {number} seriesIndex The index of the series.
+     *
+     * @param name - The name for the series.
+     * @param seriesIndex - The index of the series.
      */
     setSeriesName(name: 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 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.
+     *
+     * @param newOrder - The new order of the series array.
      */
     setOrderOfSeries(newOrder: string[]): void;
     /**
      * How the bars/lines should be placed when multiple series are rendered in the same chart, say when "split by" operation is executed on any field or
      * when multiple attributes/fields corresponding to the same set of classes are to be visualized.
      *
-     * Currently this property is only used for bar and line series.
-     *
-     * @default sideBySide
-     *
-     * @returns {WebChartStackedKinds | undefined}
+     * **Note**: Currently this property is only used for bar and line series.
      */
     get stackedType(): WebChartStackedKinds | undefined;
     set stackedType(newStackedType: WebChartStackedKinds | undefined);
     /**
      * 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;
     /**
      * Moves 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 `SerialChartDataSortingKinds.customSort`.
-     * @param {number} fromIndex The index to move the custom sort value from.
-     * @param {number} toIndex The index to move the custom sort value to.
+     *
+     * @param fromIndex - The index to move the custom sort value from.
+     * @param toIndex - The index to move the custom sort value to.
      */
     moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
     /**
      * The null category configuration of the bar chart.
+     *
+     * @requires the following to be set on the model for the null category to be applied:
+     * - `fetchNULLValues` to be set to `true` on the model.
+     * - `colorMatch` to be set to `false` on the model
      */
     get nullCategory(): WebChartNullCategory | undefined;
     set nullCategory(nullCategory: WebChartNullCategory | undefined);
     protected abstract generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Sets up the local props based on the current config.
-     * @category Protected
      */
     protected setupLocalProps(): void;
     /**
-     * Resets the config to the default config
-     * @category Protected
+     * Resets the config to the default config.
      */
     protected resetConfig(): void;
     /**
@@ -184,13 +195,11 @@ export declare abstract class SerialChartModel 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>;
@@ -202,14 +211,12 @@ export declare abstract class SerialChartModel extends ChartModel {
      * Generate the proper chart title given the current config.
      */
     generateChartTitle(): string;
-    /**
-     * Generate the proper x-axis title given the current config.
-     */
-    generateXAxisTitle(): string;
     /**
      * Generate the proper y-axis title given the current config.
      */
     generateYAxisTitle(): string;
 }
-export interface SerialChartModel extends ModelWithMultiAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithRotation, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides, ModelWithTemporalBinning {
+declare const serialChartMixins: readonly [typeof ModelWithMultiAxes, typeof ModelWithLegend, typeof ModelWithTooltips, typeof WithColorMatch, typeof WithRotatedState, typeof WithDataLabelsVisibility, typeof WithDataLabelsSymbol, typeof ModelWithXGuides, typeof ModelWithYGuides, typeof ModelWithTemporalBinning, typeof WithXAxisTitleText, typeof WithXAxisLabelsVisibility, typeof WithXAxisTitleVisibility, typeof WithXBounds, typeof WithXAxisTitleSymbol, typeof WithAxisLabelsSymbol, typeof WithAxisLinesSymbol, typeof WithGenerateXAxisTitle];
+export interface SerialChartModel extends MixinInstances<typeof serialChartMixins> {
 }
+export {};

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

@@ -1,15 +1,16 @@
 import { WebChartStatisticType } from '../../../spec';
 import { ChartConfig, CommonStrings } from '../../../utils';
 import { SerialChartConfig } from '../../interfaces/chart-interfaces';
-import { LayerInfo, SerialChartDataSortingKinds } from '../../interfaces/common';
+import { HeatChartDataSortingKinds, LayerInfo, SerialChartDataSortingKinds } from '../../interfaces/common';
 /**
- * Generate default series value
- * @param {number | undefined } props.seriesIndex - The series index.
- * @param {string} props.xAxisField - The x-axis field.
- * @param {WebChartStatisticType} props.aggregationType - The aggregation type.
- * @param {SerialChartConfig} props.config - The chart config.
- * @param {LayerInfo | undefined} props.layerInfo - The layer info.
- * @param {CommonStrings} props.commonStrings - The common strings.
+ * Generate default series value.
+ *
+ * @param props.seriesIndex - The series index.
+ * @param props.xAxisField - The x-axis field.
+ * @param props.aggregationType - The aggregation type.
+ * @param props.config - The chart config.
+ * @param props.layerInfo - The layer info.
+ * @param props.commonStrings - The common strings.
  */
 export declare function getDefaultSeriesValue<T extends SerialChartConfig>(props: {
     seriesIndex?: number;
@@ -21,41 +22,37 @@ export declare function getDefaultSeriesValue<T extends SerialChartConfig>(props
 }): (typeof props.config)["series"][0];
 /**
  * Gets the proper chart title given the current config.
- * @param {SerialChartConfig} config - The chart config.
- * @param {LayerInfo} layerInfo - The layer info.
- * @param {CommonStrings} commonStrings - The common strings.
+ *
+ * @param config - The chart config.
+ * @param layerInfo - The layer info.
+ * @param commonStrings - The common strings.
  */
 export declare function getChartTitle(config: SerialChartConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
 /**
  * Gets the aggregation type.
- * @param {ChartConfig} config
- * @returns {WebChartStatisticType | undefined}
  */
 export declare const getAggregationType: (config: ChartConfig) => WebChartStatisticType;
 /**
  * Gets the split-by field.
- * @param {ChartConfig} config
- * @returns {string}
  */
 export declare const getSplitByField: (config: ChartConfig) => string;
 /**
  * Gets the numeric fields.
- * @param {SerialChartConfig} config
  */
 export declare const getNumericFields: (config: SerialChartConfig) => string[];
 /**
  * Gets the sort order kind.
  */
-export declare const getSortOrderKind: (config: ChartConfig) => SerialChartDataSortingKinds;
+export declare const getSortOrderKind: (config: ChartConfig) => HeatChartDataSortingKinds[] | SerialChartDataSortingKinds[];
 /**
- * Build a series array based on a list of numeric fields and aggregation type,
- * when the chart has no category field.
- * @param {string} props.xAxisField - The x-axis field.
- * @param {string[]} props.numericFields - The numeric fields to include in the series.
- * @param {WebChartStatisticType} props.aggregationType - The type of aggregation to use.
- * @param {SerialChartConfig} props.config - The chart configuration.
- * @param {LayerInfo} props.layerInfo - Information about the layer.
- * @param {CommonStrings} props.commonStrings - Common strings used in the chart.
+ * Build a series array based on a list of numeric fields and aggregation type, when the chart has no category field.
+ *
+ * @param props.xAxisField - The x-axis field.
+ * @param props.numericFields - The numeric fields to include in the series.
+ * @param props.aggregationType - The type of aggregation to use.
+ * @param props.config - The chart configuration.
+ * @param props.layerInfo - Information about the layer.
+ * @param props.commonStrings - Common strings used in the chart.
  */
 export declare function buildSeriesFromFields<T extends SerialChartConfig>(props: {
     xAxisField: string;
@@ -67,12 +64,13 @@ export declare function buildSeriesFromFields<T extends SerialChartConfig>(props
 }): (typeof props.config)["series"];
 /**
  * Build a series array based on a list of numeric fields and aggregation type.
- * @param {string} props.xAxisField - The x-axis field.
- * @param {string[]} props.numericFields - The numeric fields to include in the series.
- * @param {WebChartStatisticType} props.aggregationType - The type of aggregation to use.
- * @param {SerialChartConfig} props.config - The chart configuration.
- * @param {LayerInfo} props.layerInfo - Information about the data layer.
- * @param {CommonStrings} props.commonStrings - Common strings for localization.
+ *
+ * @param props.xAxisField - The x-axis field.
+ * @param props.numericFields - The numeric fields to include in the series.
+ * @param props.aggregationType - The type of aggregation to use.
+ * @param props.config - The chart configuration.
+ * @param props.layerInfo - Information about the data layer.
+ * @param props.commonStrings - Common strings for localization.
  */
 export declare function buildSeriesUsingNumericFields<T extends SerialChartConfig>(props: {
     xAxisField: string;
@@ -84,13 +82,14 @@ export declare function buildSeriesUsingNumericFields<T extends SerialChartConfi
 }): (typeof props.config)["series"];
 /**
  * Build a series array based on a split-by field and aggregation type.
- * @param {string} props.splitByField - The split-by field.
- * @param {string} props.xAxisField - The x-axis field.
- * @param {string[]} props.numericFields - The numeric fields to include in the series.
- * @param {WebChartStatisticType} props.aggregationType - The type of aggregation to use.
- * @param {SerialChartConfig} props.config - The chart configuration.
- * @param {LayerInfo} props.layerInfo - Information about the layer.
- * @param {CommonStrings} props.commonStrings - Common strings used in the chart.
+ *
+ * @param props.splitByField - The split-by field.
+ * @param props.xAxisField - The x-axis field.
+ * @param props.numericFields - The numeric fields to include in the series.
+ * @param props.aggregationType - The type of aggregation to use.
+ * @param props.config - The chart configuration.
+ * @param props.layerInfo - Information about the layer.
+ * @param props.commonStrings - Common strings used in the chart.
  */
 export declare function buildSeriesUsingSplitByField<T extends SerialChartConfig>(props: {
     splitByField: string;
@@ -104,7 +103,7 @@ export declare function buildSeriesUsingSplitByField<T extends SerialChartConfig
 /**
  * Builds a new series array based on the provided properties.
  *
- * **NOTE: The only async operation in this function is the call to `buildSeriesUsingSplitByField`. This means that it is recommended to call this function without `await` if a split-by field is not currently being used.**
+ * **Note**: The only async operation in this function is the call to `buildSeriesUsingSplitByField`. This means that it is recommended to call this function without `await` if a split-by field is not currently being used.
  *
  * @param props.xAxisField - The field to use for the X-axis.
  * @param props.splitByField - The field to split the data by.
@@ -125,10 +124,11 @@ export declare const buildNewSeries: (props: {
 }) => Promise<void>;
 /**
  * Get the default series name.
- * @param {ChartConfig} props.config - The chart config.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {LayerInfo} props.layerInfo - The layer info.
- * @param {ModelCommonStrings} props.commonStrings - The common strings.
+ *
+ * @param props.config - The chart config.
+ * @param props.seriesIndex - The index of the series.
+ * @param props.layerInfo - The layer info.
+ * @param props.commonStrings - The common strings.
  */
 export declare const getDefaultSeriesName: (props: {
     config: SerialChartConfig;
@@ -152,14 +152,16 @@ export declare const setOrderByList: (values: string[], config: ChartConfig) =>
 export declare const getCustomSortValues: (config: SerialChartConfig, layerInfo: LayerInfo | undefined) => Promise<string[]>;
 /**
  * Get whether temporal binning is enabled for the series in the config.
- * @param {SerialChartConfig} config - The chart config.
- * @returns {boolean} - Whether temporal binning is enabled.
+ *
+ * @param config - The chart config.
+ * @returns Whether temporal binning is enabled.
  */
 export declare function getBinTemporalData(config: SerialChartConfig): boolean;
 /**
  * Enable or disable temporal binning for all series in the config.
- * @param {SerialChartConfig} config - The chart config.
- * @param {boolean} value - Whether to enable or disable temporal binning.
+ *
+ * @param config - The chart config.
+ * @param value - Whether to enable or disable temporal binning.
  *
  * **NOTE** This method removes any existing temporal binning settings if `value` is set to `false`.
  */