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

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

@@ -3,13 +3,14 @@ import { ChartConfig, CommonStrings } from '../../../utils';
 import { SerialChartConfig } from '../../interfaces/chart-interfaces';
 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,26 +22,22 @@ 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[];
 /**
@@ -48,14 +45,14 @@ export declare const getNumericFields: (config: SerialChartConfig) => string[];
  */
 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`.
  */

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

@@ -24,65 +24,66 @@ export declare const setAssignToSecondValueAxis: (props: {
 }) => void;
 /**
  * Gets the name of the series for the provided index.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig} config - The chart configuration.
- * @returns {string | undefined}
+ *
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const getSeriesName: (seriesIndex: number, config: ChartConfig) => string | undefined;
 /**
  * Sets the name of the series for the provided index.
- * @param {string} newName - The new name for the series.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig} config - The chart configuration.
+ *
+ * @param newName - The new name for the series.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setSeriesName: (newName: string, seriesIndex: number, config: ChartConfig) => void;
 /**
  * Gets the color of the series for the provided index.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig} config - The chart configuration.
- * @returns {Color | undefined}
+ *
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const getSeriesColor: (seriesIndex: number, config: ChartConfig) => Color | undefined;
 /**
  * Sets the color of the series for the provided index.
- * @param {Color | undefined} newColor - The new color for the series.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig} config - The chart configuration.
+ *
+ * @param newColor - The new color for the series.
+ * @param seriesIndex - The index of the series.
+ * @param config - The chart configuration.
  */
 export declare const setSeriesColor: (newColor: Color | undefined, seriesIndex: number, config: ChartConfig) => void;
 /**
  * Gets the list of series IDs in the order they appear in the chart config.
- * @param {ChartConfig} config - The chart configuration.
- * @returns {WebChartTypes | undefined}
+ *
+ * @param config - The chart configuration.
  */
 export declare const getOrderOfSeries: (config: ChartConfig) => string[];
 /**
  * Updates the order of the series in the chart config.
- * @param {string[]} newSeriesOrder - The new order of the series.
- * @param {ChartConfig} config - The chart configuration.
+ *
+ * @param newSeriesOrder - The new order of the series.
+ * @param config - The chart configuration.
  */
 export declare const setOrderOfSeries: (newSeriesOrder: string[], config: ChartConfig) => 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
  * 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.
+ * **Note**: Currently this property is only used for bar and line series.
  *
- * @param {SerialChartConfig} config - The chart configuration.
- * @default sideBySide
+ * @param config - The chart configuration.
  */
 export declare const getStackedType: (config: SerialChartConfig) => 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.
+ * **Note**: Currently this property is only used for bar and line series.
  *
- * @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
+ * @param props.newStackedType - The new stacked type.
+ * @param props.config - The chart configuration.
+ * @param props.layerInfo - The layer information.
+ * @param props.commonStrings - The common strings.
  */
 export declare const setStackedType: (props: {
     newStackedType: WebChartStackedKinds | undefined;
@@ -91,17 +92,15 @@ export declare const setStackedType: (props: {
     commonStrings: CommonStrings;
 }) => void;
 /**
- * Gets the `nullCategory` for the chart series.
+ * Gets the `nullCategory` for the chart series. The `nullCategory` containing text and color, or undefined if not found.
  *
- * @param {SerialChartConfig} config The chart configuration.
- * @returns {WebChartNullCategory | undefined}
- *          The nullCategory containing text and color, or undefined if not found.
+ * @param config - The chart configuration.
  */
 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.
+ * @param config - The chart configuration.
+ * @param nullCategory - The nullCategory object containing text and color.
  */
 export declare const setNullCategory: (config: SerialChartConfig, nullCategory?: WebChartNullCategory) => void;

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

@@ -30,10 +30,11 @@ export declare const setAxis: (props: {
     axisIndex: number;
 }) => void;
 /**
- * Get the maximum or minimum bound of the axis
- * @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
+ * Get the maximum or minimum bound of the axis.
+ *
+ * @param props.config - the config object
+ * @param props.axisIndex - the index of the axis
+ * @param props.isMax - whether it is the max bound or not
  */
 export declare const getAxisBound: (props: {
     config: WebChart;
@@ -41,11 +42,12 @@ export declare const getAxisBound: (props: {
     isMax: boolean;
 }) => number;
 /**
- * Set the axis bound
- * @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
+ * Set the axis bound.
+ *
+ * @param props.config - the config object
+ * @param props.value - the value to set
+ * @param props.axisIndex - the index of the axis
+ * @param props.isMax - whether it is the max bound
  */
 export declare const setAxisBound: (props: {
     config: WebChart;
@@ -54,20 +56,20 @@ export declare const setAxisBound: (props: {
     isMax: boolean;
 }) => void;
 /**
- * Set the minimum X bound
+ * 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) => void;
 /**
- * Get the valueFormat of the x-axis
- * @param config
- * @returns
+ * Get the valueFormat of the x-axis.
  */
 export declare const getXAxisValueFormat: (config: ChartConfig) => CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
 export declare const setXAxisValueFormat: (config: ChartConfig, commonStrings: CommonStrings, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions) => void;
 /**
- * Get the valueFormat of the y-axis
+ * Get the valueFormat of the y-axis.
+ *
  * @param config - the config object
  */
 export declare const getYAxisValueFormat: (config: ChartConfig) => NumberFormatOptions | undefined;
@@ -88,10 +90,10 @@ 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.
+ * @param props.axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ * @param props.config - The chart config.
+ * @param props.isMultiAxis - Optional flag indicating if the chart supports multiple axes (has a x-axis and y-axis).
+ * @returns Returns `true` if the axis index is valid, `false` otherwise.
  */
 export declare const validateAxisIndex: (props: {
     axisIndex: number;
@@ -102,9 +104,9 @@ export declare const validateAxisIndex: (props: {
  * 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.
+ * @param props.axisIndex - The index of the axis to validate (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ * @param props.func - The function to run with the valid axis index.
+ * @param props.config - The chart configuration object.
  */
 export declare const runWithDualAxisGuard: <T>(props: {
     axisIndex: number;
@@ -112,17 +114,19 @@ export declare const runWithDualAxisGuard: <T>(props: {
     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
+ * Get the value format of the axis based on the axis index.
+ *
+ * @param axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ * @returns 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)
+ *
+ * @param props.config - The chart configuration object
+ * @param props.commonStrings - Common strings
+ * @param props.valueFormat - The value format to set
+ * @param props.axisIndex - 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;
@@ -132,23 +136,21 @@ export declare const setAxisValueFormat: (props: {
 }) => 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.
  *
- * `true`: Logarithmic scale is enabled for the specified axis.
- *
- * `false`: Logarithmic scale is disabled for the specified axis.
- *
- * @returns {boolean}
+ * @param config - The chart configuration object.
+ * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
  */
 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).
+ * - `true`: Enable logarithmic scale for the specified axis.
+ * - `false`: Disable logarithmic scale for the specified axis.
+ *
+ * @param props.config - The chart configuration object.
+ * @param props.isLogarithmic - Whether to enable logarithmic scale for the specified axis.
+ * @param 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;
@@ -157,15 +159,17 @@ export declare const setAxisLogarithmic: (props: {
 }) => 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.
+ *
+ * @param config - The chart configuration object.
+ * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+ * @returns 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).
+ *
+ * @param scrollbar - The scrollbar configuration to set.
+ * @param 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;

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

@@ -19,16 +19,16 @@ export declare function getSerialChartSortOrderKind(orderBy: string[] | WebChart
  */
 export declare function getHeatChartSortOrderKind(orderBy: string[] | WebChartSortOrderKinds, orderType: Omit<WebChartOrderDataByTypes, "arcgis-charts-multi-axes">): HeatChartDataSortingKinds;
 /**
- * Get the sort order kind for the bar and line chart
- * @param {SerialChartConfig} config - the chart configuration
+ * Get the sort order kind for the bar and line chart.
  *
- * @returns {SerialChartDataSortingKinds}
+ * @param config - the chart configuration
  */
 export declare const getSortOrderKindForBarLineChart: (config: SerialChartConfig) => SerialChartDataSortingKinds;
 /**
  * Check if custom sort is enabled based on the chart type.
- * @param {SerialChartConfig} config - The chart config.
- * @returns {boolean} - True if custom sort is enabled, otherwise false.
+ *
+ * @param config - The chart config.
+ * @returns True if custom sort is enabled, otherwise false.
  */
 export declare const isCustomSortEnabled: (config: SerialChartConfig) => boolean;
 /**
@@ -40,35 +40,36 @@ export declare const isCustomSortEnabled: (config: SerialChartConfig) => boolean
  */
 export declare const getOrderByList: (config: SerialChartConfig) => string[];
 /**
- * Set the sort order kind for the bar and line chart
- * @param {SerialChartDataSortingKinds} newSortOrderKind - the new sort order kind
- * @param {ChartConfig} config - the chart configuration
- * @param {string[] | undefined} orderByList - the list of fields to order by
- * @param {boolean | undefined} isYAxis - whether to set the sort order for y-axis (heat chart only)
+ * Set the sort order kind for the bar and line chart.
+ *
+ * @param newSortOrderKind - the new sort order kind
+ * @param config - the chart configuration
+ * @param orderByList - the list of fields to order by
+ * @param isYAxis - whether to set the sort order for y-axis (heat chart only)
  */
 export declare const setSortOrderKind: (newSortOrderKind: HeatChartDataSortingKinds | SerialChartDataSortingKinds, config: ChartConfig, orderByList?: string[], isYAxis?: boolean) => void;
 /**
  * Gets the x-axis field.
- * @param {ChartConfig} config - The chart config.
- * @returns {string}
+ *
+ * @param config - The chart config.
  */
 export declare const getXAxisField: (config: ChartConfig) => string;
 /**
  * Get the name and description for the series.y based on the chart type and sub-type.
  * 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.
+ * @param props.config - The chart configuration object.
+ * @param props.xAxisField - The field used for the x-axis.
+ * @param props.numericFields - The list of numeric fields available in the data.
+ * @param props.aggregationType - The type of aggregation to apply to the numeric fields.
+ * @param props.mode - The mode for pie chart data, if applicable.
+ * @param props.layer - The layer from which the data is being queried.
+ * @param props.numericFieldIndex - The index of the numeric field to use when multiple fields are available.
+ * @param props.seriesIndex - The index of the series being configured, useful when multiple series exist.
+ * @param props.splitByField - The field used to split the data into multiple series.
+ * @param props.fieldList - 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.
+ * @returns An object containing the name and description for the series.y field.
  */
 export declare const getYForNewSeries: (props: {
     config: ChartConfig;
@@ -94,10 +95,10 @@ export declare const getYForNewSeries: (props: {
  * - 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
  *
- * @param {string} props.fieldName - The field used for the x-axis.
- * @param {IField[]} props.fieldList - list of fields to use instead of fetching them from the layer
+ * @param props.fieldName - The field used for the x-axis.
+ * @param props.fieldList - list of fields to use instead of fetching them from the layer
  *
- * @returns {boolean} True if the x-axis field is empty, otherwise false.
+ * @returns `true` if the x-axis field is empty, otherwise `false`.
  */
 export declare function xAxisFieldIsEmpty(props: {
     fieldName: string;
@@ -116,10 +117,10 @@ export declare function xAxisFieldIsEmpty(props: {
  *
  * - there is at least one numeric field available (excluding objectId field)
  *
- * @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 props.fieldName - The field used for the x-axis.
+ * @param props.numericFields - The list of numeric fields.
+ * @param props.queryObject - the query object (feature layer or feature layer view)
+ * @param props.fieldList - list of fields to use instead of fetching them from the layer
  */
 export declare function shouldUseChartFromFields(props: {
     fieldName: string;

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

@@ -50,16 +50,14 @@ declare namespace CreateModelPropsOptions {
 }
 /**
  * Properties used by the `createModel` function to create a new model.
- *
  * Various combinations of `layer`, `iLayer`, `chartType`, and `config` are supported.
  */
 type CreateModelProps<T extends ModelTypes> = CreateModelPropsOptions.ILayerAndSourcelessConfig<T> | CreateModelPropsOptions.ILayerAndType<T> | CreateModelPropsOptions.LayerAndSourcelessConfig<T> | CreateModelPropsOptions.LayerAndType<T> | CreateModelPropsOptions.SourcedConfig<T>;
 /**
  * Creates a new chart model for config interaction based on the provided properties.
- *
  * Various combinations of properties `layer`, `iLayer`, `chartType`, and `config` are supported.
  *
- * @param {CreateModelProps} props - The properties used to set up the chart.
+ * @param props - The properties used to set up the chart.
  */
 export declare function createModel<T extends ModelTypes>(props: CreateModelProps<T>): Promise<ModelOfType<T>>;
 export {};

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

@@ -2,7 +2,8 @@ import { IField, WebChart, WebChartAxis, WebChartGaugeAxis } from '../../spec';
 import { LayerInfo, SplitByFieldInfos } from '../interfaces/common';
 import { SupportedLayer } from '../../interfaces';
 /**
- * Returns the necessary information for building series based on a split-by field
+ * Returns the necessary information for building series based on a split-by field.
+ *
  * @param props.config The chart config
  * @param props.layer The layer instance
  * @param props.layerFieldsInfo Fields Information of the layer
@@ -25,17 +26,14 @@ export declare function isValidSplitByField(layerFieldsInfo: IField[], splitByFi
 export declare function isValidNumericFields(layerFieldsInfo: IField[], numericFields: string[]): boolean;
 /**
  * This function applies mixins to a class. [source](https://www.typescriptlang.org/docs/handbook/mixins.html)
- * @param derivedCtor
- * @param constructors
  */
 export declare function applyMixins(derivedCtor: any, constructors: any[]): void;
 /**
- * Get the list of category's values or labels from the layer
- * @param {LayerInfo} props.layerInfo The layer information
- * @param {WebChart} props.config The chart configuration
- * @param {string} props.category The category
+ * Get the list of category's values or labels from the layer.
  *
- * @returns {Promise<string[]>}
+ * @param props.layerInfo The layer information
+ * @param props.config The chart configuration
+ * @param props.category The category
  */
 export declare function getCategoryLabels(props: {
     layerInfo: LayerInfo;

package/dist/model.js

@@ -4,7 +4,7 @@ import { s as r, t as s, u as n } from "./chunks/type-guards.js";
 import { a as B, e as P, i as x, g as W, b as K, r as v, h as D, l as G, m as H, p as F, j as O, k as R, q as A, n as E, o as X, d as Y, f as $, c as j } from "./chunks/type-guards.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.91 */
 async function c(t) {
   const o = "config" in t ? r(t.config) : t.chartType;
   let a;

package/dist/spec/web-chart.d.ts

@@ -412,7 +412,9 @@ export interface WebChartAxis {
     /**
      * The desired minimum distance between two adjacent axis ticks. The actual distance may fluctuate depending on the chart's size.
      * When not provided a default value is assigned according to the axis type and axis labels behavior.
-     * @remarks This property only applies for axes of an XYChart, not Gauge.
+     *
+     * **Note**: This property only applies for axes of an XYChart, not Gauge.
+     *
      * @minimum 1
      */
     tickSpacing?: number;
@@ -632,9 +634,9 @@ export interface WebChartQuery {
     objectIds?: (number | string)[];
 }
 /**
- * Subset of the WebChartQuery, used at the series level
+ * Subset of the `WebChartQuery`, used at the series level.
  *
- * @remarks The former `orderByFields` property is replaced by the `orderOptions` property of `WebChart`.
+ * **Note**: The former `orderByFields` property is replaced by the `orderOptions` property of `WebChart`.
  */
 export type WebChartSeriesQuery = Omit<WebChartQuery, "distance" | "gdbVersion" | "geometry" | "num" | "objectIds" | "orderByFields" | "spatialRelationship" | "start" | "timeExtent" | "units">;
 /**