@arcgis/charts-components 5.0.0-next.4 → 5.0.0-next.41

package/dist/model/mixins/model-with-line-marker-styling.d.ts

@@ -74,8 +74,8 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isLineSmoothed(seriesIndex: number): boolean;
     /**
      * Specify whether line segments of the series should be smoothed.
-     * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
     /**
@@ -86,12 +86,10 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
      */
     getConnectLines(seriesIndex: number): boolean | undefined;
     /**
-     * Specify the color of the filled area for line chart.
-     * @param {boolean | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
-     *
-     * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
-     *
+     * Specify whether to connect the lines when there's a gap in the data.
+     * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
+     * @param {boolean | undefined} connect - Whether to connect the gap in the data
+     * @param {number} seriesIndex - The index of the series.
      */
     setConnectLines(connect: boolean | undefined, seriesIndex: number): void;
     /**
@@ -104,8 +102,8 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isAreaVisible(seriesIndex: number): boolean;
     /**
      * Specify whether the line series should show area.
-     * @param {boolean} props.visible - `true` if the line series should show area, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setAreaVisible(visible: boolean, seriesIndex: number): void;
     /**
@@ -118,23 +116,21 @@ export declare abstract class ModelWithLineMarkerStyling extends ChartModel {
     isMarkerVisible(seriesIndex: number): boolean;
     /**
      * Indicate whether to show or hide the markers/bullets of the line series.
-     * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {boolean} visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+     * @param {number} seriesIndex - The index of the series.
      */
     setMarkerVisible(visible: boolean, seriesIndex: number): void;
     /**
      * Specify the color of the filled area for line chart.
+     * **Note:** `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
      * @param {number} seriesIndex - The index of the series.
-     *
-     * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
-     *
      * @returns {Color | undefined}
      */
     getAreaColor(seriesIndex: number): Color | undefined;
     /**
      * Specify the color of the filled area for line chart.
-     * @param {Color | undefined} props.color - The color of the filled area for line chart.
-     * @param {number} props.seriesIndex - The index of the series.
+     * @param {Color | undefined} color - The color of the filled area for line chart.
+     * @param {number} seriesIndex - The index of the series.
      */
     setAreaColor(color: Color | undefined, seriesIndex: number): void;
 }

package/dist/model/mixins/model-with-multi-axes.d.ts

@@ -11,11 +11,9 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getAxisTitleText(axisIndex: number): string;
     /**
      * Sets the title text for the specified axis.
+     * **Note:** The title text for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param {string} titleText The title text for the axis.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
-     *
-     * **NOTE**: The title text for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setAxisTitleText(titleText: string, axisIndex: number): void;
     /**
@@ -26,11 +24,9 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getAxisTitleVisibility(axisIndex: number): boolean;
     /**
      * Sets the visibility of the specified axis title.
+     * **Note:** The title visibility for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param {boolean} isVisible The visibility state for the axis title.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
-     *
-     * **NOTE**: The title visibility for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setAxisTitleVisibility(isVisible: boolean, axisIndex: number): void;
     /**
@@ -41,11 +37,9 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getMaxBound(axisIndex: number): number;
     /**
      * Sets the maximum bound for the specified axis.
+     * **Note:** The maximum bound for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param {number | null} newMaxBound The value to set as the maximum bound.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
-     *
-     * **NOTE**: The maximum bound for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setMaxBound(newMaxBound: number | null, axisIndex: number): void;
     /**
@@ -56,11 +50,9 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getMinBound(axisIndex: number): number;
     /**
      * Sets the minimum bound for the specified axis.
+     * **Note:** The minimum bound for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param {number | null} newMinBound The value to set as the minimum bound.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
-     *
-     * **NOTE**: The minimum bound for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setMinBound(newMinBound: number | null, axisIndex: number): void;
     /**
@@ -71,11 +63,9 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getAxisValueFormat(axisIndex: number): CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
     /**
      * Sets the value format for the specified axis.
+     * **Note:** The value format for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
      * @param {CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions} valueFormat The value format to set.
-     *
-     * **NOTE**: The value format for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setAxisValueFormat(axisIndex: number, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions): void;
     /**
@@ -91,16 +81,11 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getLogarithmic(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.
-     *
+     * **Note:** The logarithmic scale for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param {boolean} isLogarithmic Whether to enable logarithmic scale for the specified axis.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
-     *
-     * **NOTE**: The logarithmic scale for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setLogarithmic(isLogarithmic: boolean, axisIndex: number): void;
     /**
@@ -111,25 +96,22 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getAxisScrollbar(axisIndex: number): WebChartAxisScrollBar | undefined;
     /**
      * Sets the scrollbar configuration for the specified axis.
+     * **Note:** The scrollbar configuration for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-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).
-     *
-     * **NOTE**: The scrollbar configuration for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setAxisScrollbar(scrollbar: WebChartAxisScrollBar, axisIndex: number): void;
     /**
      * Gets the specified title text symbol. Contains styling information such as font, color, and symbol style.
+     * @param {number} axisIndex The index of the axis to get the title symbol for
      * @returns {WebChartTextSymbol | undefined}
      */
     getAxisTitleSymbol(axisIndex: number): WebChartTextSymbol | undefined;
     /**
      * Sets the title text symbol for the specified axis. Contains styling information such as font, color, and symbol style.
+     * **Note:** The title text symbol for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param {WebChartTextSymbol | undefined} titleSymbol The title text symbol to set.
      * @param {number} axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
-     *
-     * **NOTE**: The title text symbol for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setAxisTitleSymbol(titleSymbol: WebChartTextSymbol | undefined, axisIndex: number): void;
     /**
@@ -139,11 +121,8 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getHorizontalAxisLabelsBehavior(): WebChartLabelBehavior;
     /**
      * Sets the horizontal axis labels behavior for the chart.
+     * **Note:** The horizontal axis labels behavior for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param horizontalBehavior The behavior for the horizontal axis labels.
-     *
-     * **NOTE**: The horizontal axis labels behavior for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
-     *
      */
     setHorizontalAxisLabelsBehavior(horizontalBehavior: WebChartLabelBehavior): void;
     /**
@@ -153,10 +132,8 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getVerticalAxisLabelsBehavior(): WebChartLabelBehavior;
     /**
      * Sets the vertical axis labels behavior for the chart.
+     * **Note:** The vertical axis labels behavior for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param verticalBehavior The behavior for the vertical axis labels.
-     *
-     * **NOTE**: The vertical axis labels behavior for the second Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart.
-     * To enable the second Y-axis, use the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setVerticalAxisLabelsBehavior(verticalBehavior: WebChartLabelBehavior): void;
     /**
@@ -166,17 +143,16 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
     getGridLinesSymbol(): ISimpleLineSymbol | undefined;
     /**
      * Sets the grid lines symbol. Contains styling information such as line width, line style, and line color.
+     * **Note:** To set the grid lines symbol for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      * @param {ISimpleLineSymbol | undefined} linesSymbol The grid lines symbol.
      * @param {number[]} axisIndices The indices of the axes to set the grid lines symbol for.
-     *
-     * **NOTE**: To set the grid lines symbol for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setGridLinesSymbol(linesSymbol: ISimpleLineSymbol | undefined, axisIndices?: number[]): void;
     /**
      * Get the default x-axis title text.
-     * @returns {Promise<string>}
+     * @returns {string}
      */
-    getDefaultXAxisTitleText(): Promise<string>;
+    getDefaultXAxisTitleText(): string;
     /**
      * Gets the display zero line setting for the specified axis.
      * @param axisIndex The index of the axis to get the display zero line for.
@@ -195,7 +171,7 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      * a. This setting is only applicable to the axis of type ValueAxis.
      * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
      *
-     * **NOTE**: To set the display zero line for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the display zero line for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setDisplayZeroLine(displayZeroLine: boolean, axisIndex: number): void;
     /**
@@ -214,7 +190,7 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      * @remarks
      * a. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
      *
-     * **NOTE**: To set the display cursor tooltip for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the display cursor tooltip for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setDisplayCursorTooltip(displayCursorTooltip: boolean, axisIndex: number): void;
     /**
@@ -235,7 +211,7 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      * a. This setting is only applicable to the axis of type ValueAxis.
      * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
      *
-     * **NOTE**: To set the buffer for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the buffer for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setBuffer(buffer: boolean, axisIndex: number): void;
     /**
@@ -253,7 +229,7 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      * @remarks
      * a. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
      *
-     * **NOTE**: To set the tick spacing for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the tick spacing for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setTickSpacing(tickSpacing: number, axisIndex: number): void;
     /**
@@ -274,14 +250,14 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      * a. This setting is only applicable to the axis of type ValueAxis.
      * b. To set the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
      *
-     * **NOTE**: To set the integer only values for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the integer only values for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     setIntegerOnlyValues(integerOnlyValues: boolean, axisIndex: number): void;
     /**
      * Visibility of the horizontal line of the cursor's crosshair.
      * @remarks if the cursor crosshair or its horizontal line visibility is not set, the default value of `false` will be returned.
      *
-     * **NOTE**: To set the cursor crosshair horizontal line visibility for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the cursor crosshair horizontal line visibility for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     get cursorCrosshairHorizontalLineVisibility(): boolean;
     set cursorCrosshairHorizontalLineVisibility(visibility: boolean);
@@ -289,21 +265,19 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      * Visibility of the vertical line of the cursor's crosshair.
      * @remarks if the cursor crosshair or its vertical line visibility is not set, the default value of `false` will be returned.
      *
-     * **NOTE**: To set the cursor crosshair vertical line visibility for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the cursor crosshair vertical line visibility for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     get cursorCrosshairVerticalLineVisibility(): boolean;
     set cursorCrosshairVerticalLineVisibility(visibility: boolean);
     /**
      * Style of the cursor's crosshair from the chart config.
-     *
-     * **NOTE**: To set the cursor crosshair style for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the cursor crosshair style for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     get cursorCrosshairStyle(): ISimpleLineSymbol | undefined;
     set cursorCrosshairStyle(style: ISimpleLineSymbol | undefined);
     /**
      * Cursor crosshair from the chart config.
-     *
-     * **NOTE**: To set the cursor crosshair for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
+     * **Note:** To set the cursor crosshair for the second Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setAssignToSecondValueAxis(true, 1)` method to assign a series to the second Y-axis.
      */
     get cursorCrosshair(): WebChartCursorCrosshair | undefined;
     set cursorCrosshair(cursorCrosshair: WebChartCursorCrosshair | undefined);
@@ -312,5 +286,5 @@ export declare abstract class ModelWithMultiAxes extends ModelWithBasicXAxis {
      *
      * @returns {string}
      */
-    abstract generateYAxisTitle(): Promise<string> | string;
+    abstract generateYAxisTitle(): string;
 }

package/dist/model/mixins/utils/baseline-stacking.d.ts

@@ -2,25 +2,19 @@ import { ChartConfig } from '../../../utils';
 import { ModelTypes } from '../../interfaces/common';
 /**
  * Specify how negative values are treated in stacked series.
+ *  * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
  * @param {number} seriesIndex - The index of the series.
  * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * NOTE: If true, negative values will be stacked on the base line.
- * If false, negative values will be stacked in relation to their previous values in the stack.
- *
  * @default true
  * @returns {boolean}
  */
 export declare const isNegativeValuesStackedToBaseline: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify how negative values are treated in stacked series.
- * @param {boolean} props.stackedToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * NOTE: If true, negative values will be stacked on the base line.
- * If false, negative values will be stacked in relation to their previous values in the stack.
- *
+ * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
+ * @param {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setNegativeValuesStackedToBaseline: (props: {
     stackNegativeValuesToBaseline: boolean;

package/dist/model/mixins/utils/line-marker-styling.d.ts

@@ -22,9 +22,9 @@ export declare const setMarkerSize: (newSize: number | undefined, seriesIndex: n
 export declare const isLineSmoothed: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify whether line segments of the series should be smoothed.
- * @param {boolean} props.smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @param {boolean} smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setLineSmoothed: (props: {
     smoothed: boolean;
@@ -42,9 +42,9 @@ export declare const setLineSmoothed: (props: {
 export declare const isAreaVisible: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Specify whether the line series should show area.
- * @param {boolean} props.visible - `true` if the line series should show area, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @param {boolean} visible - `true` if the line series should show area, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setAreaVisible: (props: {
     visible: boolean;
@@ -62,9 +62,9 @@ export declare const setAreaVisible: (props: {
 export declare const isMarkerVisible: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
 /**
  * Indicate whether to show or hide the markers/bullets of the line series.
- * @param {boolean} props.visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
+ * @param {boolean} visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setMarkerVisible: (props: {
     visible: boolean;
@@ -73,21 +73,18 @@ export declare const setMarkerVisible: (props: {
 }) => void;
 /**
  * Specify the color of the filled area for line chart.
+ * **Note:** areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
  * @param {number} seriesIndex - The index of the series.
  * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
- * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
- *
  * @returns {Color | undefined}
  */
 export declare const getAreaColor: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => Color | undefined;
 /**
  * Specify the color of the filled area for line chart.
- * @param {Color | undefined} props.color - The color of the filled area for line chart.
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * NOTE: areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ * **Note:** areaColor will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
+ * @param {Color | undefined} color - The color of the filled area for line chart.
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setAreaColor: (props: {
     color: Color | undefined;
@@ -98,17 +95,15 @@ export declare const setAreaColor: (props: {
  * Specify whether to connect the lines when there's a gap in the data.
  * @param {number} seriesIndex - The index of the series.
  * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- *
  * @returns {boolean | undefined}
  */
 export declare const getConnectLines: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean | undefined;
 /**
  * Specify whether to connect the lines when there's a gap in the data.
- * @param {boolean | undefined} props.connect - Whether to connect the gap in the data
- * @param {number} props.seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} props.config - The chart configuration.
- *
- * NOTE: Can be overridden by the temporal data setting `nullPolicy`.
+ * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
+ * @param {boolean | undefined} connect - Whether to connect the gap in the data
+ * @param {number} seriesIndex - The index of the series.
+ * @param {ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
  */
 export declare const setConnectLines: (props: {
     connect: boolean | undefined;

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

@@ -51,15 +51,17 @@ export declare class PieChartModel extends ChartModel {
     /**
      * Sets the sort order for the pie chart.
      * @param {PieChartDataSortingKinds} sortOrder The sort order.
+     * @param {string[]} orderByList The list of category values.
      */
     setSortOrder(sortOrder: PieChartDataSortingKinds, orderByList?: string[]): void;
+    /**
+     * List of category's values for custom sort
+     */
     get orderByList(): string[];
     set orderByList(orderByList: string[]);
     /**
      * The pie chart data mode (Category or Fields).
-     *
      * `category` - The chart is using values from the category field to determine each slice.
-     *
      * `fields` - The chart is using aggregated values from the numeric fields to determine each slice.
      */
     get mode(): PieChartDataModes;
@@ -71,8 +73,7 @@ export declare class PieChartModel extends ChartModel {
     getCustomSortValues(): Promise<string[]>;
     /**
      * 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 `customSort`.
+     * **Note:** This method should be only used when the sort order is set to `customSort`.
      * @param {number} fromIndex The index to move the custom sort item from.
      * @param {number} toIndex The index to move the category item to.
      */
@@ -125,6 +126,7 @@ export declare class PieChartModel extends ChartModel {
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
     /**
      * Gets the original name of the slice based on the slice index.
+     * @param {number} sliceIndex - The index of the slice.
      * @returns {Date | number | string | null | undefined}
      */
     getOriginalSliceName(sliceIndex: number): Date | number | string | null | undefined;

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

@@ -99,8 +99,7 @@ export declare abstract class SerialChartModel extends ChartModel {
     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`.
+     * **Note:** Setting this prop removes any existing temporal binning settings if `value` is set to `false`.
      */
     get binTemporalData(): boolean;
     set binTemporalData(value: boolean);
@@ -159,14 +158,17 @@ 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;
     /**
      * The null category configuration of the bar chart.
+     *
+     * @requires the following to be set on the model for the null category to be applied:
+     * - `fetchNULLValues` to be set to `true` on the model.
+     * - `colorMatch` to be set to `false` on the model
      */
     get nullCategory(): WebChartNullCategory | undefined;
     set nullCategory(nullCategory: WebChartNullCategory | undefined);

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

@@ -144,11 +144,8 @@ export declare const setAxisValueFormat: (props: {
 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).

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

@@ -1,5 +1,5 @@
 import { ChartConfig } from '../../utils';
-import { SupportedLayer, WebChartStatisticType } from '../../spec';
+import { IField, SupportedLayer, WebChartStatisticType } from '../../spec';
 import { PieChartDataModes, SerialChartDataSortingKinds } from '../interfaces/common';
 import { SerialChartConfig } from '../interfaces/chart-interfaces';
 import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
@@ -47,6 +47,10 @@ export declare const getXAxisField: (config: ChartConfig) => string;
  * @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.
  */
@@ -60,11 +64,49 @@ export declare const getYForNewSeries: (props: {
     numericFieldIndex?: number;
     seriesIndex?: number;
     splitByField?: string;
+    fieldList?: IField[];
 }) => {
     name: string;
     description: string;
 };
+/**
+ * Determines if the x-axis field is considered "empty" for chart from fields scenarios.
+ *
+ * An x-axis field is considered empty when:
+ * - the x-axis field is not defined, or
+ * - the x-axis field is an empty string, 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
+ *
+ * @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
+ *
+ * @returns {boolean} True if the x-axis field is empty, otherwise false.
+ */
+export declare function xAxisFieldIsEmpty(props: {
+    fieldName: string;
+    fieldList: IField[];
+}): boolean;
 /**
  * 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 `xAxisFieldIsEmpty` returns true, meaning:
+ * - the x-axis field is not defined, or
+ * - the x-axis field is an empty string, 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 (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
  */
-export declare function shouldUseChartFromFields(xAxisField?: string, numericFields?: string[]): boolean;
+export declare function shouldUseChartFromFields(props: {
+    fieldName: string;
+    numericFields: string[];
+    fieldList: IField[];
+}): boolean;

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 S, g as x, b as W, r as v, h as G, l as K, m as D, p as F, j as H, k as O, q as R, n as A, o as E, d as X, f as Y, c as $ } 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.4 */
+v5.0.0-next.41 */
 async function c(t) {
   const o = "config" in t ? r(t.config) : t.chartType;
   let a;

package/dist/spec/data-source.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@arcgis/core/interfaces.d.ts" />
 import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer';
 import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer';
 import { WebChartTemporalBinningUnits } from './chart-object-literals';
@@ -6,6 +7,11 @@ import { Color, IExtent, ISimpleLineSymbol, ISymbol, SimpleFillSymbolStyle, Simp
  * Supported layer type for ArcGIS charts.
  */
 export type SupportedLayer = FeatureLayer | SubtypeSublayer;
+/**
+ * Esri Layer type
+ * @see {@link https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html
+ */
+export type Layer = __esri.Layer;
 /**
  * JSON representation of the color object
  */
@@ -67,6 +73,11 @@ export interface WebChartGenericDataItem {
      * Time interval information, only for line charts
      */
     timeIntervalInfo?: TimeIntervalInfo;
+    /**
+     * Indicates whether the server limit has been reached when fetching data.
+     * Currently applies only to the queries leveraging the /queryBins operation.
+     */
+    serverLimitReached?: boolean;
 }
 /**
  * JSON representation of a Histogram bin