@arcgis/charts-components 5.0.0-next.2 → 5.0.0-next.21

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,10 +143,9 @@ 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;
     /**
@@ -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);

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,8 +158,7 @@ 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.
      */

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.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.2 */
+v5.0.0-next.21 */
 async function c(t) {
   const o = "config" in t ? r(t.config) : t.chartType;
   let a;

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

@@ -67,6 +67,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

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

@@ -6,7 +6,7 @@ import { Color, IDrawingInfo, IEnvelope, IExtent, IFeatureLayer, IPoint, IPolygo
 /**
  * Version of the current specification.
  */
-export declare const WebChartCurrentVersion = "24.3.0";
+export declare const WebChartCurrentVersion = "24.4.0";
 /**
  * Stores information regarding a numeric conversion
  */
@@ -267,7 +267,7 @@ export interface DateTimeFormatOptions {
      */
     type: typeof WebChartTypes.DateAxisFormat;
     /**
-     * Represent the JS native [Intl.DateTimeFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormatt), which is based on [CLDR](http://cldr.unicode.org/translation/date-time-1/date-time-patterns) specifications.
+     * Represent the JS native [Intl.DateTimeFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat), which is based on [CLDR](http://cldr.unicode.org/translation/date-time-1/date-time-patterns) specifications.
      */
     intlOptions: Intl.DateTimeFormatOptions;
     /**

package/dist/store.d.ts

@@ -1,3 +1,4 @@
+import { TimeIntervalInfo } from './spec';
 /**
  * Type definition for axes bound data
  * Holds the default and current min and max bound values for an axis
@@ -28,15 +29,18 @@ type AppState = {
     chartAxesBoundDataMap: ChartAxesBoundDataMap;
     /** Stores cached scatterplot data representing specific UI states that are not saved at the model level */
     scatterplotData: ScatterplotDataMap;
+    /** Stores cached time binning interval for each chart */
+    timeBinningIntervalMap: Record<string, TimeIntervalInfo | undefined>;
 };
 declare const state: {
     selectedChartId: string;
     chartAxesBoundDataMap: ChartAxesBoundDataMap;
     scatterplotData: ScatterplotDataMap;
+    timeBinningIntervalMap: {};
 };
 /**
  * Generates the min max axis key for the selected chart based on the axis type and logarithmic scale.
- * The key is used to fetch/store the min max axis related values in the stencil store for the selected chart
+ * The key is used to fetch/store the min max axis related values in the state for the selected chart
  *
  * @param {string} props.chartId - The selected chart id
  * @param {boolean} props.isXAxis - The axis type (`true` for x-axis, `false` for y-axis)
@@ -48,9 +52,26 @@ export declare const generateAxisMinMaxKey: (props: {
     isLogarithmic: boolean;
 }) => string;
 /**
- * Deletes the min max axis key from the stencil store for the selected chart
+ * Deletes the min max axis key from the state for the selected chart
  *
- * @param {AppState} appState - The current app state in the stencil store
+ * @param {AppState} appState - The current app state
  */
 export declare const deleteMinMaxAxisKey: (appState: AppState) => void;
+/**
+ * Gets the axes bound data for the selected chart
+ * @param {AppState} appState - The current app state
+ * @returns {TimeIntervalInfo | undefined} - The axes bound data map for the selected chart
+ */
+export declare const getTimeBinningForChart: (appState: AppState) => TimeIntervalInfo | undefined;
+/**
+ * Sets the time binning interval for a specific chart
+ * @param {AppState} appState - The current app state
+ * @param {TimeIntervalInfo} timeBinning - The time binning interval to set
+ */
+export declare const setTimeBinningForChart: (appState: AppState, timeBinning: TimeIntervalInfo) => void;
+/**
+ * Resets the time binning interval for a specific chart
+ * @param {AppState} appState - The current app state
+ */
+export declare const resetTimeBinningForChart: (appState: AppState) => void;
 export default state;

package/dist/test/chart-rendering/test-utils/utils.d.ts

@@ -1,11 +1,3 @@
-/**
- * Provides a way to mock a private function.
- *
- * @param privateFunctionFolder The folder under src containing the private function
- * @param functionName The function to mock
- * @param mockedImplementation The mocked implementation
- */
-export declare function mockPrivateFunction(privateFunctionFolder: string, functionName: string, mockedImplementation: any): Promise<void>;
 /**
  * Resets the mocked implementation of a specific private function
  *

package/dist/utils/chart-config/converter/index.d.ts

@@ -388,12 +388,12 @@ declare function convertTo21x1x0(configToUpdate: WebChart): WebChart;
  */
 declare function convertTo23x3x0(configToUpdate: WebChart): WebChart;
 /**
- * Conversion for v24.3.0:
+ * Conversion for v24.4.0:
  * - Converts the temporal binning properties from the old pattern to the new pattern
  * @param configToUpdate The chart's config to update
  * @returns The updated chart config
  */
-declare function convertTo24x3x0(configToUpdate: WebChart): WebChart;
+declare function convertTo24x4x0(configToUpdate: WebChart): WebChart;
 /**
  * Apply the needed function calls depending on the current chart version.
  * Note: Additional switch cases and convertToxxx functions are to be added to this function accordingly.
@@ -476,7 +476,7 @@ export declare const chartConfigConverterPrivateFunctions: {
     convertTo20x2x0: typeof convertTo20x2x0;
     convertTo21x1x0: typeof convertTo21x1x0;
     convertTo23x3x0: typeof convertTo23x3x0;
-    convertTo24x3x0: typeof convertTo24x3x0;
+    convertTo24x4x0: typeof convertTo24x4x0;
     convertTemporalBinningProps2: typeof convertTemporalBinningProps2;
     applyConversions: typeof applyConversions;
     convertDataSourceToILayer: typeof convertDataSourceToILayer;

package/dist/utils/chart-config/utils/index.d.ts

@@ -124,6 +124,13 @@ export declare function isSeriesUsingTimeBinning(props: {
  * @param series The series to test
  */
 export declare function doesSeriesSupportTemporalBinning(series: WebChartSeriesType): series is WebChartSeriesSupportingTemporalBinning;
+/**
+ * Compares two config data filters and returns true if they are identical, false otherwise
+ *
+ * @param oldConfig
+ * @param newConfig
+ */
+export declare function hasConfigFilterChanged(oldConfig: WebChart, newConfig: WebChart): boolean;
 export declare const chartConfigUtilsPrivateFunctions: {
     getPieChartChartSubType: typeof getPieChartChartSubType;
     getBarLineChartSubType: typeof getBarLineChartSubType;

package/dist/utils/chart-config/validator/index.d.ts

@@ -61,16 +61,6 @@ declare function findWarnings(props: {
  * @param chartConfig The chart config
  */
 declare function findCustomErrors(queryObject?: QueryObject, chartConfig?: WebChart | WebGaugeChart): Promise<CustomErrorObject[]>;
-export declare const chartConfigValidatorPrivateFunctions: {
-    findCustomErrors: typeof findCustomErrors;
-    findWarnings: typeof findWarnings;
-    findNumericAggregationWarnings: typeof findNumericAggregationWarnings;
-    findDuplicateSeriesIDWarnings: typeof findDuplicateSeriesIDWarnings;
-    findLayerLoadError: typeof findLayerLoadError;
-    createStartingSchema: typeof createStartingSchema;
-    extractSchemaNameFromRefPath: typeof extractSchemaNameFromRefPath;
-    customizeValidationErrors: typeof customizeValidationErrors;
-};
 /**
  * Validates the `WebChart` config by checking for  and displays `Errors` and `Warnings`.
  * - `Errors` are violations in the config w.r.t the JSON schema.
@@ -90,4 +80,14 @@ export declare function validateWebChart(props: {
  * @param config The config to analyze
  */
 export declare function isPartialConfig(config?: WebChart): boolean;
+export declare const chartConfigValidatorPrivateFunctions: {
+    findCustomErrors: typeof findCustomErrors;
+    findWarnings: typeof findWarnings;
+    findNumericAggregationWarnings: typeof findNumericAggregationWarnings;
+    findDuplicateSeriesIDWarnings: typeof findDuplicateSeriesIDWarnings;
+    findLayerLoadError: typeof findLayerLoadError;
+    createStartingSchema: typeof createStartingSchema;
+    extractSchemaNameFromRefPath: typeof extractSchemaNameFromRefPath;
+    customizeValidationErrors: typeof customizeValidationErrors;
+};
 export {};

package/dist/utils/components/config-update.d.ts

@@ -2,6 +2,7 @@ import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLa
 import { ChartOptions } from '../../chart-rendering/common/interfaces';
 import { ArcgisChart } from '../../components/arcgis-chart/customElement.js';
 import { SupportedLayer, WebChart, WebChartLegendPositions } from '../../spec';
+import { QueryObject } from '../../utils';
 /**
  * Updates the legend position for a given WebChart config.
  * Returns the updated config.
@@ -40,7 +41,14 @@ export declare function isValidDataSource(config?: WebChart, layer?: FeatureLaye
  * - adding missing series was requested (through the `updateSplitBySeries` property)
  * - unique values for the given split-by field don't have a series associated
  *
- * @param component The chart component
- * @param options The runtime options
+ * @param props.component The chart component
+ * @param props.options The runtime options
+ * @param props.config The chart config
+ * @param props.queryObject The query object (layer or feature layer view)
  */
-export declare function addMissingSplitBySeries(component: ArcgisChart, config: WebChart | undefined, options: ChartOptions): Promise<void>;
+export declare function addMissingSplitBySeries(props: {
+    component: ArcgisChart;
+    config: WebChart | undefined;
+    options: ChartOptions;
+    queryObject: QueryObject;
+}): Promise<void>;