@arcgis/charts-components 4.34.0-next.15 → 4.34.0-next.150

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

@@ -0,0 +1,78 @@
+import { ISimpleLineSymbol, ISimpleMarkerSymbol, WebChart, SizePolicy, ScatterplotOverlays } from '../../spec';
+import { ChartConfig, XYChartTypes } from '../../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';
+export declare class ScatterplotModel extends ChartModel {
+    /**
+     * Current configuration used for the scatterplot.
+     */
+    protected _config: ChartConfig<typeof ModelTypes.Scatterplot, WebChart>;
+    protected _chartType: XYChartTypes;
+    protected layerInfo: LayerInfo;
+    setup(params: ModelParams<ChartConfig<typeof ModelTypes.Scatterplot>>): Promise<void>;
+    /**
+     * X-axis field.
+     */
+    get xAxisField(): string;
+    set xAxisField(fieldName: string);
+    /**
+     * Y-axis field.
+     */
+    get yAxisField(): string;
+    set yAxisField(fieldName: string);
+    /**
+     * Whether the linear trend line is shown.
+     */
+    get showLinearTrend(): boolean;
+    set showLinearTrend(show: boolean);
+    /**
+     * Line symbol for the linear trend line.
+     */
+    get linearTrendSymbol(): ISimpleLineSymbol;
+    set linearTrendSymbol(symbol: ISimpleLineSymbol);
+    /**
+     * Marker symbol used for the scatterplot points when using a fixed symbol (i.e. no size policy is set).
+     */
+    get fixedMarkerSymbol(): ISimpleMarkerSymbol;
+    set fixedMarkerSymbol(symbol: ISimpleMarkerSymbol);
+    /**
+     * Size policy for the scatterplot points. This is used to scale the size of the marker symbol based on a given field.
+     */
+    get sizePolicy(): SizePolicy | undefined;
+    set sizePolicy(sizePolicy: SizePolicy | undefined);
+    /**
+     * Chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
+     */
+    get seriesOverlays(): ScatterplotOverlays | undefined;
+    set seriesOverlays(overlays: ScatterplotOverlays | undefined);
+    /**
+     * Additional tooltip display fields.
+     *
+     * **NOTE**: Only numeric fields are supported.
+     */
+    get additionalTooltipField(): string[] | string;
+    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 {
+}

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

@@ -0,0 +1,116 @@
+import { SizePolicy, ISimpleMarkerSymbol, ISimpleLineSymbol, ScatterplotOverlays } from '../../../spec';
+import { CommonStrings, ScatterplotConfig } from '../../../utils';
+import { LayerInfo } from '../../interfaces/common';
+/**
+ * Generate the proper chart title given the current config.
+ */
+export declare function generateChartTitle(config: ScatterplotConfig, layerInfo: LayerInfo, commonStrings: CommonStrings): string;
+/**
+ * Gets the x-axis field from the config
+ * @param config The scatterplot config
+ */
+export declare const getXAxisField: (config: ScatterplotConfig) => string;
+/**
+ * Gets the y-axis field from the config
+ * @param config The scatterplot config
+ */
+export declare const getYAxisField: (config: ScatterplotConfig) => string;
+/**
+ * Sets the x-axis field name in the config
+ * @param fieldName The x-axis field name
+ * @param config The scatterplot config
+ * @param layerInfo The layer info
+ * @param commonStrings The common strings
+ */
+export declare const setXAxisField: (props: {
+    fieldName: string;
+    config: ScatterplotConfig;
+    layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
+}) => void;
+/**
+ * Sets the y-axis field in the config
+ * @param fieldName The y-axis field name
+ * @param config The scatterplot config
+ * @param layerInfo The layer info
+ * @param commonStrings The common strings
+ */
+export declare const setYAxisField: (props: {
+    fieldName: string;
+    config: ScatterplotConfig;
+    layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
+}) => void;
+/**
+ * Gets fixed marker symbol from the config
+ * @param config The scatterplot config
+ */
+export declare const getFixedMarkerSymbol: (config: ScatterplotConfig) => ISimpleMarkerSymbol;
+/**
+ * Sets the fixed marker symbol in the config
+ * @param symbol The fixed marker symbol
+ * @param config The scatterplot config
+ */
+export declare const setFixedMarkerSymbol: (symbol: ISimpleMarkerSymbol, config: ScatterplotConfig) => void;
+/**
+ * Gets the show linear trend option from the config
+ * @param config The scatterplot config
+ */
+export declare const getShowLinearTrend: (config: ScatterplotConfig) => boolean;
+/**
+ * Gets linear trend symbol from the config
+ * @param config The scatterplot config
+ */
+export declare const getLinearTrendSymbol: (config: ScatterplotConfig) => ISimpleLineSymbol;
+/**
+ * Sets the linear trend option in the config
+ * @param symbol The linear trend symbol
+ * @param config The scatterplot config
+ */
+export declare const setLinearTrendSymbol: (symbol: ISimpleLineSymbol, config: ScatterplotConfig) => void;
+/**
+ * Sets the visibility of the linear trend line in the scatterplot config
+ * @param visibility The visibility of the linear trend line
+ * @param config The scatterplot config
+ */
+export declare const setLinearTrendLineVisibility: (visibility: boolean, config: ScatterplotConfig) => void;
+/**
+ * Sets show linear trend in the config
+ * @param show Whether to show linear trend line
+ * @param config The scatterplot config
+ */
+export declare const setShowLinearTrend: (show: boolean, config: ScatterplotConfig) => void;
+/**
+ * Gets the size policy from the config
+ * @param config The scatterplot config
+ */
+export declare const getSizePolicy: (config: ScatterplotConfig) => SizePolicy | undefined;
+/**
+ * Sets the size policy in the config
+ * @param sizePolicy The size policy
+ * @param config The scatterplot config
+ */
+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
+ */
+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
+ */
+export declare const setSeriesOverlays: (overlays: ScatterplotOverlays, config: ScatterplotConfig) => void;
+/**
+ * Gets the additional tooltip display fields from the config.
+ * @param {ScatterplotConfig} 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
+ *
+ */
+export declare const setAdditionalTooltipField: (fields: string[] | string | undefined, config: ScatterplotConfig) => void;

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

@@ -1,9 +1,9 @@
 import { SerialChartTypes } from '../../utils';
 import { ChartModel } from '../chart-model/chart-model';
-import { Color, WebChartStatisticType, WebChartDataFilters, WebChartStackedKinds } from '@arcgis/charts-spec';
+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, ModelWithXYAxes, ModelWithYGuides } from '../mixins';
+import { ModelWithColorMatch, ModelWithDataLabels, ModelWithLegend, ModelWithTooltips, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithYGuides, ModelWithMultiAxes } from '../mixins';
 export declare abstract class SerialChartModel extends ChartModel {
     /**
      * Current chart type.
@@ -15,75 +15,57 @@ export declare abstract class SerialChartModel extends ChartModel {
      */
     protected _config: SerialChartConfig;
     /**
-     * Gets the x-axis field for the chart.
-     * @returns {string}
-     */
-    getXAxisField(): string;
-    /**
-     * Sets the x-axis field for the chart.
-     * @param {string} newXAxisField The new x-axis field.
-     */
-    setXAxisField(newXAxisField: string): Promise<void>;
-    /**
-     * Gets the aggregation type for the bar chart.
-     * @returns {WebChartStatisticType}
-     */
-    getAggregationType(): WebChartStatisticType;
-    /**
-     * Sets the aggregation type for the chart.
-     * @param {WebChartStatisticType} newAggregationType The new aggregation type. Must be one of the values allowed by `WebChartStatisticType`.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     * Internal storage of the x-axis field for the chart.
+     * @category Protected
      */
-    setAggregationType(newAggregationType: WebChartStatisticType): Promise<void>;
+    protected _xAxisField: string;
     /**
-     * Gets whether the series should be assigned to the second value axis.
-     * @param seriesIndex - The index of the series.
-     * @returns {boolean}
+     * Internal storage of the aggregation type for the chart.
+     * @category Protected
      */
-    getAssignToSecondValueAxis(seriesIndex: number): boolean;
+    protected _aggregationType: WebChartStatisticType;
     /**
-     * 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.
+     * Internal storage of the split-by field for the chart.
+     * @category Protected
      */
-    setAssignToSecondValueAxis(assign: boolean, seriesIndex: number): void;
+    protected _splitByField: string;
     /**
-     * Gets the split-by field for the chart.
-     * @returns {string}
+     * Internal storage of the numeric fields for the chart.
+     * @category Protected
      */
-    getSplitByField(): string;
+    protected _numericFields: string[];
     /**
-     * Sets the split-by field for the chart.
-     * @param {string} newSplitByField The new split-by field.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     * The x-axis field for the chart.
      */
-    setSplitByField(newSplitByField: string): Promise<void>;
+    get xAxisField(): string;
+    set xAxisField(newXAxisField: string);
     /**
-     * Gets the numeric fields array for the chart.
-     * @returns {string[]}
+     * The aggregation type for the bar chart. Must be one of the values allowed by `WebChartStatisticType`.
      */
-    getNumericFields(): string[];
+    get aggregationType(): WebChartStatisticType;
+    set aggregationType(newAggregationType: WebChartStatisticType);
     /**
-     * Sets the numeric field or numeric fields array for the chart.
-     * @param {string | string[]} newNumericFields The new numeric field string or numeric fields array.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
+     * The split-by field for the chart.
      */
-    setNumericFields(newNumericFields: string[] | string): Promise<void>;
+    get splitByField(): string;
+    set splitByField(newSplitByField: string);
     /**
-     * Gets the data filter for the bar chart.
-     * @returns {WebChartDataFilters | undefined}
+     * The numeric fields array for the chart.
      */
-    getDataFilter(): WebChartDataFilters | undefined;
+    get numericFields(): string[];
+    set numericFields(newNumericFields: string[] | string);
     /**
-     * Sets the data filter for the bar chart.
-     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     * Gets whether the series should be assigned to the second value axis.
+     * @param seriesIndex - The index of the series.
+     * @returns {boolean}
      */
-    setDataFilter(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
+    getAssignToSecondValueAxis(seriesIndex: number): boolean;
     /**
-     * Gets the list of the category values for the chart.
-     * @returns {string[]}
+     * 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.
      */
-    getCustomSortValues(): Promise<string[]>;
+    setAssignToSecondValueAxis(assign: boolean, seriesIndex: number): void;
     /**
      * Gets the sort order for the bar chart.
      * @returns {"xAxisAsc" | "xAxisDesc" | "yAxisAsc" | "yAxisDesc" | "customSort"}
@@ -96,20 +78,31 @@ export declare abstract class SerialChartModel extends ChartModel {
      */
     setSortOrder(newSortOrder: SerialChartDataSortingKinds, orderByList?: string[]): void;
     /**
-     * Gets the list of custom sort values for custom sort
+     * Gets the list of the category values for the chart.
      * @returns {string[]}
      */
-    getOrderByList(): string[];
+    getCustomSortValues(): Promise<string[]>;
+    /**
+     * Sets the data filter for the bar chart.
+     * @param {WebChartDataFilters | undefined} newDataFilter The new data filter.
+     */
+    setDataFilters(newDataFilter: WebChartDataFilters | undefined): Promise<void>;
     /**
-     * Sets the list of custom sort values for custom sort
-     * @param {string[]} newOrderByList The new list of custom sort values
+     * The list of custom sort values for custom sort
      */
-    setOrderByList(newOrderByList: string[]): void;
+    get orderByList(): string[];
+    set orderByList(newOrderByList: string[]);
     /**
      * 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>;
+    /**
+     * Whether temporal binning is enabled for all series in the config.
+     * **Note:** Setting this prop removes any existing temporal binning settings if `value` is set to `false`.
+     */
+    get binTemporalData(): boolean;
+    set binTemporalData(value: boolean);
     /**
      * Gets the name of the series based on the series index.
      * If the index is out of bounds, it will return `undefined`.
@@ -146,7 +139,7 @@ export declare abstract class SerialChartModel extends ChartModel {
      */
     setOrderOfSeries(newOrder: string[]): void;
     /**
-     * Gets 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
+     * 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.
@@ -155,18 +148,8 @@ export declare abstract class SerialChartModel extends ChartModel {
      *
      * @returns {WebChartStackedKinds | undefined}
      */
-    getStackedType(): WebChartStackedKinds | undefined;
-    /**
-     * Sets 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.
-     *
-     * @param {WebChartStackedKinds | undefined} newStackedType The new stacked type.
-     *
-     * @default sideBySide
-     */
-    setStackedType(newStackedType: WebChartStackedKinds | undefined): Promise<void>;
+    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.
@@ -175,17 +158,58 @@ export declare abstract class SerialChartModel extends ChartModel {
     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`.
+     * **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.
      */
     moveCustomSortValuesInOrderByList(fromIndex: number, toIndex: number): void;
-    protected abstract generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    /**
+     * The null category configuration of the bar chart.
+     */
+    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
+     */
+    protected resetConfig(): void;
+    /**
+     * Determines if we can rebuild the series synchronously.
+     * 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>;
+    /**
+     * Gets the properties needed to build a new series array.
+     */
+    private getBuildNewSeriesProps;
+    /**
+     * 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.
      */
-    protected resetConfig(): Promise<void>;
+    generateYAxisTitle(): string;
 }
-export interface SerialChartModel extends ModelWithXYAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithRotation, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides, ModelWithTemporalBinning {
+export interface SerialChartModel extends ModelWithMultiAxes, ModelWithLegend, ModelWithTooltips, ModelWithColorMatch, ModelWithRotation, ModelWithDataLabels, ModelWithXGuides, ModelWithYGuides, ModelWithTemporalBinning {
 }

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

@@ -1,73 +1,48 @@
-import { WebChartDataFilters, WebChartStatisticType } from '@arcgis/charts-spec';
-import { ChartConfig } from '../../../utils';
+import { WebChartStatisticType } from '../../../spec';
+import { ChartConfig, CommonStrings } from '../../../utils';
 import { SerialChartConfig } from '../../interfaces/chart-interfaces';
 import { LayerInfo, SerialChartDataSortingKinds } from '../../interfaces/common';
-import { ModelCommonStrings } from '../../t9n/common/interfaces';
 /**
  * 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.
- *
- * @returns {WebChartBarChartSeries | WebChartLineChartSeries}
+ * @param {CommonStrings} props.commonStrings - The common strings.
  */
 export declare function getDefaultSeriesValue<T extends SerialChartConfig>(props: {
     seriesIndex?: number;
+    xAxisField: string;
+    aggregationType: WebChartStatisticType;
     config: T;
     layerInfo?: LayerInfo | undefined;
-}): Promise<(typeof props.config)["series"][0]>;
+    commonStrings: CommonStrings;
+}): (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.
- * @returns {string}
+ * @param {CommonStrings} commonStrings - The common strings.
  */
-export declare function getChartTitle(config: SerialChartConfig, layerInfo: LayerInfo): Promise<string>;
+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;
-/**
- * Set the aggregation type by updating the config accordingly.
- * @param {WebChartStatisticType} newAggregationType - The new aggregation type.
- * @param {SerialChartConfig} config - The chart config.
- * @param {LayerInfo} layerInfo - The layer info.
- */
-export declare const setAggregationType: (newAggregationType: WebChartStatisticType, config: SerialChartConfig, layerInfo: LayerInfo) => Promise<void>;
 /**
  * Gets the split-by field.
  * @param {ChartConfig} config
  * @returns {string}
  */
 export declare const getSplitByField: (config: ChartConfig) => string;
-/**
- * Set the split-by field by updating the config accordingly.
- * @param {string} newSplitByField - The new split-by field.
- * @param {SerialChartConfig} config - The chart config.
- * @param {LayerInfo} layerInfo - The layer info.
- */
-export declare const setSplitByField: (newSplitByField: string, config: SerialChartConfig, layerInfo: LayerInfo) => Promise<void>;
 /**
  * Gets the numeric fields.
  * @param {SerialChartConfig} config
  */
 export declare const getNumericFields: (config: SerialChartConfig) => string[];
-/**
- * Sets the category field by updating the config accordingly.
- * @param {string[]} newNumericFields - The new numeric fields.
- * @param {SerialChartConfig} config - The chart config.
- * @param {LayerInfo} layerInfo - The layer info.
- */
-export declare const setNumericFields: (newNumericFields: string[], config: SerialChartConfig, layerInfo: LayerInfo) => Promise<void>;
-/**
- * Set the x-axis field by updating the config accordingly.
- * @param {string} newXAxisField - The new x-axis field.
- * @param {ChartConfig} config - The chart config.
- * @param {LayerInfo} layerInfo - The layer info.
- */
-export declare const setXAxisField: (newXAxisField: string, config: SerialChartConfig, layerInfo: LayerInfo | undefined) => Promise<void>;
 /**
  * Gets the sort order kind.
  */
@@ -75,58 +50,78 @@ export declare const getSortOrderKind: (config: ChartConfig) => SerialChartDataS
 /**
  * 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 data layer.
+ * @param {LayerInfo} props.layerInfo - Information about the layer.
+ * @param {CommonStrings} props.commonStrings - Common strings used in the chart.
  */
 export declare function buildSeriesFromFields<T extends SerialChartConfig>(props: {
+    xAxisField: string;
     numericFields: string[];
     aggregationType: WebChartStatisticType;
     config: T;
     layerInfo: LayerInfo;
-}): Promise<(typeof props.config)["series"]>;
+    commonStrings: CommonStrings;
+}): (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.
  */
 export declare function buildSeriesUsingNumericFields<T extends SerialChartConfig>(props: {
+    xAxisField: string;
     numericFields: string[];
     aggregationType: WebChartStatisticType;
     config: T;
     layerInfo: LayerInfo;
-}): Promise<(typeof props.config)["series"]>;
+    commonStrings: CommonStrings;
+}): (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.
  */
 export declare function buildSeriesUsingSplitByField<T extends SerialChartConfig>(props: {
     splitByField: string;
+    xAxisField: string;
     numericFields: string[];
     aggregationType: WebChartStatisticType;
     config: T;
     layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
 }): Promise<(typeof props.config)["series"]>;
 /**
  * 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.**
+ *
+ * @param props.xAxisField - The field to use for the X-axis.
  * @param props.splitByField - The field to split the data by.
  * @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 used in the chart.
  */
 export declare const buildNewSeries: (props: {
+    xAxisField: string;
     splitByField: string;
     numericFields: string[];
     aggregationType: WebChartStatisticType;
     config: SerialChartConfig;
     layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
 }) => Promise<void>;
 /**
  * Get the default series name.
@@ -139,7 +134,7 @@ export declare const getDefaultSeriesName: (props: {
     config: SerialChartConfig;
     seriesIndex: number;
     layerInfo: LayerInfo;
-    commonStrings: ModelCommonStrings;
+    commonStrings: CommonStrings;
 }) => string;
 /**
  * Set the order by list in the config. The order by list is only used when the sort order kind is custom sort.
@@ -147,18 +142,6 @@ export declare const getDefaultSeriesName: (props: {
  * @param  {ChartConfig} config - The chart config.
  */
 export declare const setOrderByList: (values: string[], config: ChartConfig) => void;
-/**
- * Get the data filter from the config.
- * @param  {ChartConfig} config - The chart config.
- * @returns WebChartDataFilters | undefined - The data filter.
- */
-export declare const getDataFilter: (config: ChartConfig) => WebChartDataFilters | undefined;
-/**
- * Set the data filter in the config.
- * @param  {WebChartDataFilters | undefined} dataFilter - The data filter.
- * @param  {ChartConfig} config - The chart config.
- */
-export declare const setDataFilter: (dataFilter: WebChartDataFilters | undefined, config: ChartConfig) => void;
 /**
  * Get the custom sort values from the config.
  * @param  {SerialChartConfig} config - The chart config.
@@ -167,3 +150,17 @@ export declare const setDataFilter: (dataFilter: WebChartDataFilters | undefined
  * @returns string[] - The custom sort values.
  */
 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.
+ */
+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.
+ *
+ * **NOTE** This method removes any existing temporal binning settings if `value` is set to `false`.
+ */
+export declare function setBinTemporalData(value: boolean, config: SerialChartConfig): void;