@arcgis/charts-components 4.34.0-next.98 → 4.34.0

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

@@ -1,72 +1,48 @@
-import { WebChartDataFilters, WebChartStatisticType } from '@arcgis/charts-spec';
+import { WebChartStatisticType } from '../../../spec';
 import { ChartConfig, CommonStrings } from '../../../utils';
 import { SerialChartConfig } from '../../interfaces/chart-interfaces';
 import { 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.
- *
- * @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) => Promise<void>;
 /**
  * Gets the sort order kind.
  */
@@ -74,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.
@@ -146,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.
@@ -166,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;

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

@@ -1,5 +1,5 @@
-import { Color, WebChartStackedKinds } from '@arcgis/charts-spec';
-import { ChartConfig } from '../../../utils';
+import { Color, WebChartNullCategory, WebChartStackedKinds } from '../../../spec';
+import { ChartConfig, CommonStrings } from '../../../utils';
 import { SerialChartConfig } from '../../interfaces/chart-interfaces';
 import { LayerInfo } from '../../interfaces/common';
 /**
@@ -11,11 +11,17 @@ import { LayerInfo } from '../../interfaces/common';
 export declare const getAssignToSecondValueAxis: (seriesIndex: number, config: ChartConfig) => boolean;
 /**
  * Sets the setting for whether to assign the series to the second value axis.
- * @param assign The boolean value to set.
- * @param seriesIndex The index of the series.
- * @param config The chart configuration.
+ * @param props.assign The boolean value to set.
+ * @param props.seriesIndex The index of the series.
+ * @param props.config The chart configuration.
+ * @param props.commonStrings Common strings
  */
-export declare const setAssignToSecondValueAxis: (assign: boolean, seriesIndex: number, config: ChartConfig) => void;
+export declare const setAssignToSecondValueAxis: (props: {
+    assign: boolean;
+    seriesIndex: number;
+    config: ChartConfig;
+    commonStrings: CommonStrings;
+}) => void;
 /**
  * Gets the name of the series for the provided index.
  * @param {number} seriesIndex - The index of the series.
@@ -75,10 +81,27 @@ export declare const getStackedType: (config: SerialChartConfig) => WebChartStac
  * @param {SerialChartConfig} props.config - The chart configuration.
  * @param {WebChartStackedKinds | undefined} props.newStackedType - The new stacked type.
  * @param {LayerInfo | undefined} props.layerInfo - The layer information.
+ * @param {CommonStrings} props.commonStrings - The common strings.
  * @default sideBySide
  */
 export declare const setStackedType: (props: {
     newStackedType: WebChartStackedKinds | undefined;
     config: SerialChartConfig;
     layerInfo: LayerInfo | undefined;
-}) => Promise<void>;
+    commonStrings: CommonStrings;
+}) => void;
+/**
+ * Gets the `nullCategory` for the chart series.
+ *
+ * @param {SerialChartConfig} config The chart configuration.
+ * @returns {WebChartNullCategory | undefined}
+ *          The nullCategory containing text and color, or undefined if not found.
+ */
+export declare const getNullCategory: (config: SerialChartConfig) => WebChartNullCategory | undefined;
+/**
+ * Sets the `nullCategory` for all bar and line chart series in the given chart config.
+ *
+ * @param {SerialChartConfig} config The chart configuration.
+ * @param {WebChartNullCategory} nullCategory The nullCategory object containing text and color.
+ */
+export declare const setNullCategory: (config: SerialChartConfig, nullCategory?: WebChartNullCategory) => void;

package/dist/model/shared/axes.d.ts

@@ -1,5 +1,5 @@
-import { ChartConfig } from '../../utils';
-import { CategoryFormatOptions, DateTimeFormatOptions, NumberFormatOptions, WebChart, WebChartAxis, WebChartStatisticType } from '@arcgis/charts-spec';
+import { ChartConfig, CommonStrings } from '../../utils';
+import { CategoryFormatOptions, DateTimeFormatOptions, NumberFormatOptions, WebChart, WebChartAxis, WebChartAxisScrollBar, WebChartStatisticType } from '../../spec';
 import { LayerInfo } from '../interfaces/common';
 /**
  * Updates the axis config with the provided title text. Provides a default title object if one does not exist.
@@ -14,88 +14,64 @@ export declare function updateAxisTitle(config: WebChart, axisIndex: number, tit
 export declare function getYAxisTitleLabel(props: {
     config: WebChart | undefined;
     layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
     numericFields: string[];
     aggregationType: WebChartStatisticType;
-}): Promise<string>;
+}): string;
 /**
  * Get the axes of the chart
  * @param config - the config object
  */
 export declare const getAxes: (config: WebChart) => WebChartAxis[] | undefined;
-export declare const getAxis: (config: WebChart, axisIndex: number) => Promise<WebChartAxis>;
-export declare const setAxis: (config: WebChart, axis: WebChartAxis, axisIndex: number) => void;
+export declare const getAxis: (config: WebChart, axisIndex: number, commonStrings: CommonStrings) => WebChartAxis;
+export declare const setAxis: (props: {
+    config: WebChart;
+    axis: WebChartAxis;
+    axisIndex: number;
+}) => void;
 /**
  * Get the maximum or minimum bound of the axis
- * @param config - the config object
- * @param axisIndex - the index of the axis
- * @param isMax - whether it is the max bound or not
+ * @param {WebChart} props.config - the config object
+ * @param {number} props.axisIndex - the index of the axis
+ * @param {boolean} props.isMax - whether it is the max bound or not
  */
-export declare const getAxisBound: (config: WebChart, axisIndex: number, isMax: boolean) => number;
+export declare const getAxisBound: (props: {
+    config: WebChart;
+    axisIndex: number;
+    isMax: boolean;
+}) => number;
 /**
  * Set the axis bound
- * @param config - the config object
- * @param value - the value to set
- * @param axisIndex - the index of the axis
- * @param isMax - whether it is the max bound
- */
-export declare const setAxisBound: (config: WebChart, value: number | null, axisIndex: number, isMax: boolean) => Promise<void>;
-/**
- * Get the maximum bound for the y-axis
- * @param config - the config object
- */
-export declare const getMaxYBound: (config: ChartConfig) => number;
-/**
- * Set the maximum Y bound
- * @param config - the config object
- * @param newMaxYBound - the value to set
- */
-export declare const setMaxYBound: (config: ChartConfig, newMaxYBound: number | null) => Promise<void>;
-/**
- * Get the minimum bound for the y-axis
- * @param config - the config object
- */
-export declare const getMinYBound: (config: ChartConfig) => number;
-/**
- * Set the minimum Y bound
- * @param config - the config object
- * @param newMinYBound - the value to set
- */
-export declare const setMinYBound: (config: ChartConfig, newMinYBound: number | null) => Promise<void>;
-/**
- * Get the maximum bound for the x-axis
- * @param config - the config object
- */
-export declare const getMaxXBound: (config: ChartConfig) => number;
-/**
- * Set the maximum X bound
- * @param config - the config object
- * @param newMaxXBound - the value to set
- */
-export declare const setMaxXBound: (config: ChartConfig, newMaxXBound: number | null) => Promise<void>;
-/**
- * Get the minimum bound for the x-axis
- * @param config - the config object
- */
-export declare const getMinXBound: (config: ChartConfig) => number;
+ * @param {WebChart} props.config - the config object
+ * @param {number | null} props.value - the value to set
+ * @param {number} props.axisIndex - the index of the axis
+ * @param {boolean} props.isMax - whether it is the max bound
+ */
+export declare const setAxisBound: (props: {
+    config: WebChart;
+    value: number | null;
+    axisIndex: number;
+    isMax: boolean;
+}) => void;
 /**
  * Set the minimum X bound
  * @param config - the config object
  * @param newMinXBound - the value to set
  */
-export declare const setMinXBound: (config: ChartConfig, newMinXBound: number | null) => Promise<void>;
+export declare const setMinXBound: (config: ChartConfig, newMinXBound: number | null) => void;
 /**
  * Get the valueFormat of the x-axis
  * @param config
  * @returns
  */
 export declare const getXAxisValueFormat: (config: ChartConfig) => CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
-export declare const setXAxisValueFormat: (config: ChartConfig, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions) => Promise<void>;
+export declare const setXAxisValueFormat: (config: ChartConfig, commonStrings: CommonStrings, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions) => void;
 /**
  * Get the valueFormat of the y-axis
  * @param config - the config object
  */
 export declare const getYAxisValueFormat: (config: ChartConfig) => NumberFormatOptions | undefined;
-export declare const setYAxisValueFormat: (config: ChartConfig, valueFormat?: NumberFormatOptions) => Promise<void>;
+export declare const setYAxisValueFormat: (config: ChartConfig, commonStrings: CommonStrings, valueFormat?: NumberFormatOptions) => void;
 /**
  * Set the integer only values in the axis
  * @param config - the config object
@@ -103,3 +79,96 @@ export declare const setYAxisValueFormat: (config: ChartConfig, valueFormat?: Nu
  * @param integerOnlyValues - the value to set
  */
 export declare const setIntegerOnlyValuesInAxis: (config: WebChart, axisIndex: number, integerOnlyValues: boolean) => void;
+/**
+ * Check if the chart supports dual axes
+ * @param config - the chart configuration
+ * @returns boolean - true if the config has dual axes, false otherwise
+ */
+export declare const isDualAxisSupported: (config: WebChart) => boolean;
+/**
+ * Validates the axis index based on the chart configuration and whether it supports dual axes.
+ *
+ * @param {number} props.axisIndex - axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ * @param {WebChart} props.config - config The chart config.
+ * @param {boolean} [props.isMultiAxis] - isMultiAxis Optional flag indicating if the chart supports multiple axes (has a x-axis and y-axis).
+ * @returns {boolean} - Returns true if the axis index is valid, false otherwise.
+ */
+export declare const validateAxisIndex: (props: {
+    axisIndex: number;
+    config: WebChart;
+    isMultiAxis?: boolean;
+}) => boolean;
+/**
+ * Run a util function on valid axis, ensuring that only valid changes are applied on the valid axes.
+ * If the index is invalid, it returns undefined.
+ *
+ * @param {number} props.axisIndex - The index of the axis to validate (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ * @param {function} props.func - The function to run with the valid axis index.
+ * @param {WebChart} props.config - The chart configuration object.
+ */
+export declare const runWithDualAxisGuard: <T>(props: {
+    axisIndex: number;
+    func: (validIndex: number) => T;
+    config: WebChart;
+}) => T | undefined;
+/**
+ * Get the value format of the axis based on the axis index
+ * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ * @returns {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined} The value format options for the specified axis index
+ */
+export declare const getAxisValueFormat: (axisIndex: number, config: WebChart) => CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
+/**
+ * Sets the value format for the specified axis.
+ * @param {WebChart} props.config - The chart configuration object
+ * @param {CommonStrings} props.commonStrings - Common strings
+ * @param {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions} [props.valueFormat] - The value format to set
+ * @param {number} [props.axisIndex=0] - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis)
+ */
+export declare const setAxisValueFormat: (props: {
+    config: WebChart;
+    commonStrings: CommonStrings;
+    valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions;
+    axisIndex?: number;
+}) => void;
+/**
+ * Gets whether logarithmic scale is enabled for the specified axis.
+ * @param {WebChart} config The chart configuration object.
+ * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ *
+ * `true`: Logarithmic scale is enabled for the specified axis.
+ *
+ * `false`: Logarithmic scale is disabled for the specified axis.
+ *
+ * @returns {boolean}
+ */
+export declare const getAxisLogarithmic: (config: WebChart, axisIndex: number) => boolean;
+/**
+ * Sets whether logarithmic scale is enabled for the specified axis.
+ * `true`: Enable logarithmic scale for the specified axis.
+ * `false`: Disable logarithmic scale for the specified axis.
+ * @param {WebChart} props.config The chart configuration object.
+ * @param {boolean} props.isLogarithmic Whether to enable logarithmic scale for the specified axis.
+ * @param {number} props.axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ */
+export declare const setAxisLogarithmic: (props: {
+    config: WebChart;
+    isLogarithmic: boolean;
+    axisIndex: number;
+}) => void;
+/**
+ * Gets the scrollbar configuration for the specified axis.
+ * @param {WebChart} config The chart configuration object.
+ * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ * @returns {WebChartAxisScrollBar | undefined} The scrollbar configuration for the specified axis.
+ */
+export declare const getAxisScrollbar: (config: WebChart, axisIndex: number) => WebChartAxisScrollBar | undefined;
+/**
+ * Sets the scrollbar configuration for the specified axis.
+ * @param {WebChartAxisScrollBar} scrollbar The scrollbar configuration to set.
+ * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ */
+export declare const setAxisScrollbar: (props: {
+    config: WebChart;
+    scrollbar: WebChartAxisScrollBar;
+    axisIndex: number;
+}) => void;

package/dist/model/shared/data.d.ts

@@ -1,8 +1,8 @@
 import { ChartConfig } from '../../utils';
-import { SupportedLayer, WebChartStatisticType } from '@arcgis/charts-spec';
+import { IField, SupportedLayer, WebChartStatisticType } from '../../spec';
 import { PieChartDataModes, SerialChartDataSortingKinds } from '../interfaces/common';
 import { SerialChartConfig } from '../interfaces/chart-interfaces';
-import { FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
+import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
 /**
  * Get the sort order kind for the bar and line chart
  * @param {SerialChartConfig} config - the chart configuration
@@ -42,15 +42,21 @@ export declare const getXAxisField: (config: ChartConfig) => string;
  * This function is used to determine the name and description for the y-axis in the chart configuration.
  *
  * @param {ChartConfig} props.config - The chart configuration object.
+ * @param {string} props.xAxisField - The field used for the x-axis.
  * @param {string[]} props.numericFields - The list of numeric fields available in the data.
  * @param {WebChartStatisticType} props.aggregationType - The type of aggregation to apply to the numeric fields.
  * @param {PieChartDataModes} [props.mode] - [Optional] The mode for pie chart data, if applicable.
  * @param {FeatureLayerView | SupportedLayer} [props.layer] - [Optional] The layer from which the data is being queried.
+ * @param {number} [props.numericFieldIndex] - [Optional] The index of the numeric field to use when multiple fields are available.
+ * @param {number} [props.seriesIndex] - [Optional] The index of the series being configured, useful when multiple series exist.
+ * @param {string} [props.splitByField] - [Optional] The field used to split the data into multiple series.
+ * @param {IField[]} [props.fieldList] - [Optional] List of fields to use instead of fetching them from the layer.
  *
  * @returns {Object} An object containing the name and description for the series.y field.
  */
 export declare const getYForNewSeries: (props: {
     config: ChartConfig;
+    xAxisField: string;
     numericFields: string[];
     aggregationType: WebChartStatisticType;
     mode?: PieChartDataModes;
@@ -58,7 +64,31 @@ export declare const getYForNewSeries: (props: {
     numericFieldIndex?: number;
     seriesIndex?: number;
     splitByField?: string;
+    fieldList?: IField[];
 }) => {
     name: string;
     description: string;
 };
+/**
+ * Determines if the chart should be built as a "chart from fields" based on the x-axis field and numeric fields.
+ *
+ * This is true when:
+ * - the x-axis field is not defined, or
+ * - the x-axis field does not match any of the layer fields
+ * - the x-axis field is set to the default "from fields" variation name
+ *
+ * AND
+ *
+ * - there is at least one numeric field available.
+ *
+ * @param {string} props.fieldName - The field used for the x-axis.
+ * @param {string[]} props.numericFields - The list of numeric fields.
+ * @param {QueryObject} props.queryObject - the query object (feature layer or feature layer view)
+ * @param {IField[]} [props.fieldList] - list of fields to use instead of fetching them from the layer
+ * @param {string} props.objectIdField - the objectId field of the layer
+ */
+export declare function shouldUseChartFromFields(props: {
+    fieldName: string;
+    numericFields: string[];
+    fieldList: IField[];
+}): boolean;

package/dist/model/shared/series.d.ts

@@ -1,4 +1,4 @@
-import { RESTSimpleLineSymbolStyle, WebChartLineChartSeries, WebChartRadarChartSeries } from '@arcgis/charts-spec';
+import { RESTSimpleLineSymbolStyle, WebChartLineChartSeries, WebChartRadarChartSeries } from '../../spec';
 export declare const getLineStyleFromSeries: (series: WebChartLineChartSeries | WebChartRadarChartSeries) => RESTSimpleLineSymbolStyle | undefined;
 export declare const setLineStyleToSeries: (newStyle: RESTSimpleLineSymbolStyle | undefined, series: WebChartLineChartSeries | WebChartRadarChartSeries) => void;
 export declare const getLineWidthFromSeries: (series: WebChartLineChartSeries | WebChartRadarChartSeries) => number | undefined;

package/dist/model/shared/setup-utils.d.ts

@@ -1,5 +1,5 @@
 import { ChartConfig } from '../../utils';
-import { IFeatureLayer, SupportedLayer } from '@arcgis/charts-spec';
+import { IFeatureLayer, SupportedLayer } from '../../spec';
 import { ModelOfType, ModelTypes } from '../interfaces/common';
 declare namespace CreateModelPropsOptions {
     /**

package/dist/model/shared/type-guards.d.ts

@@ -1,6 +1,6 @@
-import { WebChart } from '@arcgis/charts-spec';
+import { WebChart } from '../../spec';
 import { BarChartModel, BoxPlotModel, ChartModel, HistogramModel, LineChartModel, ModelOfType, ModelTypes, PieChartModel, ScatterplotModel, SerialChartModel } from '..';
-import { ModelWithBasicXAxis, ModelWithDataLabels, ModelWithGuides, ModelWithLegend, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithXYAxes, ModelWithYGuides } from '../mixins/index';
+import { ModelWithBasicXAxis, ModelWithDataLabels, ModelWithGuides, ModelWithLegend, ModelWithRotation, ModelWithTemporalBinning, ModelWithXGuides, ModelWithYGuides, ModelWithMultiAxes } from '../mixins/index';
 /**
  * Determines if the provided model or config is a `ChartModel`.
  * @param model The model to check.
@@ -49,10 +49,10 @@ export declare function isHistogramModel(model: ChartModel | undefined): model i
  */
 export declare function isModelWithBasicXAxis(model: ChartModel | undefined): model is ModelWithBasicXAxis;
 /**
- * Type guard for ModelWithXYAxes
+ * Type guard for ModelWithMultiAxes
  * @param model
  */
-export declare function isModelWithXYAxes(model: ChartModel | undefined): model is ModelWithXYAxes;
+export declare function isModelWithMultiAxes(model: ChartModel | undefined): model is ModelWithMultiAxes;
 /**
  * Type guard for ModelWithRotation
  * @param model

package/dist/model/shared/utils.d.ts

@@ -1,4 +1,4 @@
-import { IField, SupportedLayer, WebChart, WebChartAxis, WebChartGaugeAxis } from '@arcgis/charts-spec';
+import { IField, SupportedLayer, WebChart, WebChartAxis, WebChartGaugeAxis } from '../../spec';
 import { LayerInfo, SplitByFieldInfos } from '../interfaces/common';
 /**
  * Returns the necessary information for building series based on a split-by field
@@ -17,7 +17,6 @@ export declare function getSplitByFieldInfos(props: {
     xAxisField?: string;
     splitByField: string;
     aggregationFields: string[];
-    aggregationType?: string;
     fetchNullValues?: boolean;
 }): Promise<SplitByFieldInfos>;
 export declare function isWebGaugeChartAxis(params: WebChartAxis[] | [WebChartGaugeAxis] | undefined): params is [WebChartGaugeAxis];