@arcgis/charts-components 5.2.0-next.60 → 5.2.0-next.62

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

@@ -4,30 +4,18 @@ import type { WebChartLabelBehavior } from "../../spec/chart-object-literals.js"
 import type { ISimpleLineSymbol } from "../../spec/rest-js-types.js";
 
 export abstract class ModelWithMultiAxes extends ChartModel {
-  /**
-   * Cursor crosshair from the chart config.
-   *
-   * **Note:** To set the cursor crosshair for the secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
-   */
+  /** Gets the cursor crosshair. */
   accessor cursorCrosshair: WebChartCursorCrosshair | undefined;
   /**
-   * Visibility of the horizontal line of the cursor's crosshair.
+   * Gets the visibility of the horizontal line of the cursor's crosshair.
    * - 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 secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    */
   accessor cursorCrosshairHorizontalLineVisibility: boolean;
-  /**
-   * Style of the cursor's crosshair from the chart config.
-   *
-   * **Note:** To set the cursor crosshair style for the secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
-   */
+  /** Gets the style of the cursor's crosshair. */
   accessor cursorCrosshairStyle: ISimpleLineSymbol | undefined;
   /**
-   * Visibility of the vertical line of the cursor's crosshair.
+   * Gets the visibility of the vertical line of the cursor's crosshair.
    * - 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 secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    */
   accessor cursorCrosshairVerticalLineVisibility: boolean;
   /** Generate the proper y-axis title from the current config. */
@@ -35,14 +23,13 @@ export abstract class ModelWithMultiAxes extends ChartModel {
   /**
    * Gets the visibility of the specified axis labels.
    *
-   * @param axisIndex - axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
-   * @returns {boolean}
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getAxisLabelsVisibility(axisIndex: number): boolean;
   /**
    * Gets the scrollbar configuration for the specified axis.
    *
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getAxisScrollbar(axisIndex: number): WebChartAxisScrollBar | undefined;
   /**
@@ -54,54 +41,50 @@ export abstract class ModelWithMultiAxes extends ChartModel {
   /**
    * Gets the title text of the specified axis.
    *
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getAxisTitleText(axisIndex: number): string;
   /**
    * Gets the visibility of the specified axis title.
    *
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getAxisTitleVisibility(axisIndex: number): boolean;
   /**
    * Gets the value format for the specified axis.
    *
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getAxisValueFormat(axisIndex: number): CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined;
   /**
    * Gets the visibility of the specified axis.
    *
-   * @param axisIndex - axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
-   * @returns {boolean}
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getAxisVisibility(axisIndex: number): boolean;
   /**
    * Gets the buffer setting for the specified axis.
-   * - This setting is only applicable to the axis of type ValueAxis.
-   * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+   * - This setting is only applicable to the axis of type `ValueAxis`.
    * - If the `buffer` is not set on the axis, the default value of `false` will be returned.
    *
-   * @param axisIndex - The index of the axis
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getBuffer(axisIndex: number): boolean;
   /** Get the default x-axis title text. */
   getDefaultXAxisTitleText(): string;
   /**
    * Gets the display cursor tooltip setting for the specified axis.
-   * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
-   * - If the displayCursorTooltip is not set on the axis, the default value of `false` will be returned.
+   * - If `displayCursorTooltip` is not set on the axis, the default value of `false` will be returned.
    *
-   * @param axisIndex - The index of the axis to get the display cursor tooltip for.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getDisplayCursorTooltip(axisIndex: number): boolean;
   /**
    * Gets the display zero line setting for the specified axis.
-   * - This setting is only applicable to the axis of type ValueAxis.
-   * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
-   * - If the displayZeroLine is not set on the axis, the default value of `false` will be returned.
+   * - This setting is only applicable to the axis of type `ValueAxis`.
+   * - If the `displayZeroLine` is not set on the axis, the default value of `false` will be returned.
    *
-   * @param axisIndex - The index of the axis to get the display zero line for.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getDisplayZeroLine(axisIndex: number): boolean;
   /** Gets the grid lines symbol. Contains styling information such as line width, line style, and line color. */
@@ -110,196 +93,176 @@ export abstract class ModelWithMultiAxes extends ChartModel {
   getHorizontalAxisLabelsBehavior(): WebChartLabelBehavior;
   /**
    * Gets the integer only values setting for the specified axis.
-   * - This setting is only applicable to the axis of type ValueAxis.
-   * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
+   * - This setting is only applicable to the axis of type `ValueAxis`.
    * - If the `integerOnlyValues` is not set on the axis, the default value of `false` will be returned.
    *
-   * @param axisIndex - The index of the axis
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getIntegerOnlyValues(axisIndex: number): boolean;
   /**
    * Gets whether logarithmic scale is enabled for the specified axis.
-   * - `true`: Logarithmic scale is enabled for the specified axis.
-   * - `false`: Logarithmic scale is disabled for the specified axis.
    *
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getLogarithmic(axisIndex: number): boolean;
   /**
    * Gets the maximum bound for the specified axis.
    *
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getMaxBound(axisIndex: number): number;
   /**
    * Gets the minimum bound for the specified axis.
    *
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getMinBound(axisIndex: number): number;
   /**
    * Gets the tick spacing setting for the specified axis.
-   * - To get the setting for the x-axis, the axisIndex should be `0`. For the y-axis, the axisIndex should be `1`.
    *
-   * @param axisIndex - The index of the axis
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   getTickSpacing(axisIndex: number): number | undefined;
   /** Gets the vertical axis labels behavior for the chart. */
   getVerticalAxisLabelsBehavior(): WebChartLabelBehavior;
   /**
    * Sets the visibility of the specified axis labels.
-   * **Note:** The labels visibility for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
-   * @param isVisible - isVisible The visibility state for the axis labels.
-   * @param axisIndex - axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param isVisible - The visibility state for the axis labels.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setAxisLabelsVisibility(isVisible: boolean, axisIndex: number): void;
   /**
    * Sets the scrollbar configuration for the specified axis.
-   * **Note:** The scrollbar configuration for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary 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).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setAxisScrollbar(scrollbar: WebChartAxisScrollBar, axisIndex: number): void;
   /**
    * 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 secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param titleSymbol - The title text symbol to set.
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setAxisTitleSymbol(titleSymbol: WebChartTextSymbol | undefined, axisIndex: number): void;
   /**
    * Sets the title text for the specified axis.
-   * **Note:** The title text for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param titleText - The title text for the axis.
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setAxisTitleText(titleText: string, axisIndex: number): void;
   /**
    * Sets the visibility of the specified axis title.
-   * **Note:** The title visibility for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param isVisible - The visibility state for the axis title.
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setAxisTitleVisibility(isVisible: boolean, axisIndex: number): void;
   /**
    * Sets the value format for the specified axis.
-   * **Note:** The value format for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    * @param valueFormat - The value format to set.
    */
   setAxisValueFormat(axisIndex: number, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions): void;
   /**
    * Sets the visibility of the specified axis.
-   * **Note:** The visibility for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
-   * @param isVisible - isVisible The visibility state for the axis.
-   * @param axisIndex - axisIndex The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param isVisible - The visibility state for the axis.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setAxisVisibility(isVisible: boolean, axisIndex: number): void;
   /**
    * Sets the buffer for the specified axis.
-   * - This setting is only applicable to the axis of type ValueAxis.
-   * - 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 secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
+   * - This setting is only applicable to the axis of type `ValueAxis`.
    *
-   * @param buffer - The setting for the buffer
-   * @param axisIndex - The index of the axis
+   * @param buffer - The setting for the buffer.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setBuffer(buffer: boolean, axisIndex: number): void;
   /**
    * Sets the display cursor tooltip setting for the specified axis.
-   * - 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 secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param displayCursorTooltip - The display cursor tooltip setting for the axis.
-   * @param axisIndex - The index of the axis to set the display cursor tooltip for.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setDisplayCursorTooltip(displayCursorTooltip: boolean, axisIndex: number): void;
   /**
    * Sets the display zero line setting for the specified axis.
-   *
-   * - This setting is only applicable to the axis of type ValueAxis.
-   * - 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 secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
+   * - This setting is only applicable to the axis of type `ValueAxis`.
    *
    * @param displayZeroLine - The display zero line setting for the axis.
-   * @param axisIndex - The index of the axis to set the display zero line for.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setDisplayZeroLine(displayZeroLine: boolean, axisIndex: number): void;
   /**
    * 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 secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param linesSymbol - The grid lines symbol.
    * @param axisIndices - The indices of the axes to set the grid lines symbol for. If omitted, the symbol is applied to all axes.
+   * @example
+   * ```ts
+   * // Set the grid lines symbol for all axes since `axisIndices` is omitted
+   * chartModel.setGridLinesSymbol(
+   *   {
+   *      type: "esriSLS",
+   *      style: "esriSLSDashDot",
+   *      color: [0, 0, 128, 255],
+   *      width: 3,
+   *    }
+   * );
+   * ```
+   *
+   * ![setGridLinesSymbol](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/setGridLinesSymbol.avif)
+   * @see [Styling with charts model](https://developers.arcgis.com/javascript/latest/charts/features-and-capabilities/styling-and-theming/#styling-with-charts-model)
    */
   setGridLinesSymbol(linesSymbol: ISimpleLineSymbol | undefined, axisIndices?: number[]): void;
   /**
    * Sets the horizontal axis labels behavior for the chart.
-   * **Note:** The horizontal axis labels behavior for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param horizontalBehavior - The behavior for the horizontal axis labels.
    */
   setHorizontalAxisLabelsBehavior(horizontalBehavior: WebChartLabelBehavior): void;
   /**
    * Sets the integer only values setting for the specified axis.
-   * - This setting is only applicable to the axis of type ValueAxis.
-   * - 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 secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
+   * - This setting is only applicable to the axis of type `ValueAxis`.
    *
-   * @param integerOnlyValues - The boolean value to set for the integer only values setting
-   * @param axisIndex - The index of the axis
+   * @param integerOnlyValues - The boolean value to set for the integer only values setting.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setIntegerOnlyValues(integerOnlyValues: boolean, axisIndex: number): void;
   /**
    * 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 secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param isLogarithmic - Whether to enable logarithmic scale for the specified axis.
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setLogarithmic(isLogarithmic: boolean, axisIndex: number): void;
   /**
    * Sets the maximum bound for the specified axis.
-   * **Note:** The maximum bound for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param newMaxBound - The value to set as the maximum bound.
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setMaxBound(newMaxBound: number | null, axisIndex: number): void;
   /**
    * Sets the minimum bound for the specified axis.
-   * **Note:** The minimum bound for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param newMinBound - The value to set as the minimum bound.
-   * @param axisIndex - The index of the axis (0 for X-axis, 1 for Y-axis, 2 for second Y-axis).
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setMinBound(newMinBound: number | null, axisIndex: number): void;
   /**
    * Sets the tick spacing for the specified axis.
-   * - 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 secondary Y-axis (axisIndex 2), ensure there is a second Y-axis in the chart by using the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
-   * @param tickSpacing - The value to set for the tick spacing
-   * @param axisIndex - The index of the axis
+   * @param tickSpacing - The value to set for the tick spacing.
+   * @param axisIndex - Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
    */
   setTickSpacing(tickSpacing: number, axisIndex: number): void;
   /**
    * Sets the vertical axis labels behavior for the chart.
-   * **Note:** The vertical axis labels behavior for the secondary Y-axis (axisIndex 2) will only be applied if there is a second Y-axis in the chart. To enable the secondary Y-axis, use the `setSeriesToSecondaryYAxis(true, 1)` method to assign a series to the secondary Y-axis.
    *
    * @param verticalBehavior - The behavior for the vertical axis labels.
    */

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

@@ -107,6 +107,8 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
    * @param toIndex - Index to move the series to.
    */
   moveSeries(fromIndex: number, toIndex: number): void;
+  /** Rebuilds the series based on the current configuration. */
+  rebuildSeries(): Promise<void>;
   /**
    * Sets whether the series should be assigned to the second value axis.
    *
@@ -146,6 +148,11 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
    *
    * @param assign - The value for the setting.
    * @param seriesIndex - The index of the series.
+   * @example
+   * ```ts
+   * chartModel.setSeriesToSecondaryYAxis(true, 0); // Assigns the first series to the secondary y-axis
+   * chartModel.setSeriesToSecondaryYAxis(false, 1); // Removes the second series from the secondary y-axis
+   * ```
    */
   setSeriesToSecondaryYAxis(assign: boolean, seriesIndex: number): void;
   /**
@@ -155,7 +162,11 @@ export abstract class SerialChartModel extends SerialChartModelSuperclass {
    * @param orderByList - The list of category's values to order by.
    */
   setSortOrder(newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, orderByList?: string[]): void;
-  /** Updates the series based on the layer filter. */
+  /**
+   * Updates the series based on the layer filter.
+   *
+   * @deprecated since 5.2. Use [rebuildSeries](https://developers.arcgis.com/javascript/latest/references/charts-components/model/serial-chart-model/serial-chart-model/#rebuildSeries) instead.
+   */
   updateSeriesFromLayerFilter(): void;
 }
 declare const SerialChartModelSuperclass: typeof ChartModel & typeof WithTimeZone & typeof WithGenerateXAxisTitle & typeof WithAxisLinesSymbol & typeof WithAxisLabelsSymbol & typeof WithXAxisTitleSymbol & typeof WithXBounds & typeof WithXAxisTitleVisibility & typeof WithXAxisLabelsVisibility & typeof WithXAxisTitleText & typeof ModelWithTemporalBinning & typeof ModelWithYGuides & typeof ModelWithXGuides & typeof WithDataLabelsSymbol & typeof WithDataLabelsVisibility & typeof WithRotatedState & typeof WithColorMatch & typeof ModelWithTooltips & typeof ModelWithLegend & typeof ModelWithMultiAxes

package/dist/utils/chart-config/converter/index.js

@@ -1,12 +1,12 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
 import { getElementLocale as $e } from "@arcgis/toolkit/intl/dom";
-import { cloneDeep as n, isEmpty as B } from "lodash-es";
+import { cloneDeep as n, isEmpty as h } from "lodash-es";
 import { DateTime as Qe } from "luxon";
-import { af as Ye, Q as se, Z as Je, cS as ne, dg as ae, ct as Ke, a$ as Xe, ac as Ze, Y as O, bo as Ue, O as b, c3 as te, aI as et, aJ as tt, m as Z, bD as rt, h as it, bJ as ot, w as st } from "../../../chunks/index2.js";
+import { af as Ye, Q as se, Z as Je, cS as ne, dh as ae, cs as Ke, a$ as Xe, ac as Ze, Y as O, bo as Ue, O as b, c3 as te, aI as et, aJ as tt, m as Z, bD as rt, h as it, bJ as ot, w as st } from "../../../chunks/index2.js";
 import { W as nt, aB as at, g as dt, G as lt, ag as ct } from "../../../chunks/index.js";
 import { d as ut } from "../../../chunks/type-guards.js";
 import { C as f, h as k, q as de } from "../../../chunks/index3.js";
-import { g as h, s as ft } from "../../../chunks/series-types.js";
+import { g as B, s as ft } from "../../../chunks/series-types.js";
 import { v as re, u as c, r as F, n as p, p as v, f as pt, j as ie, s as C } from "../../../chunks/chart-object-literals.js";
 import { p as yt, e as mt, f as gt, h as St } from "../../../chunks/class-breaks.js";
 import { i as vt } from "../../../chunks/rest-js-object-literals.js";
@@ -22,7 +22,7 @@ function le(r) {
   }
   return o;
 }
-function Bt(r) {
+function ht(r) {
   const e = n(r);
   if (ae(e)) {
     const t = e.series[0], o = e.chartRenderer?.classBreakInfos;
@@ -42,17 +42,17 @@ function Bt(r) {
 }
 function ce(r) {
   const e = n(r);
-  return B(r.axes) || (e.axes = r.axes?.map((i) => {
+  return h(r.axes) || (e.axes = r.axes?.map((i) => {
     const t = i;
     return delete t.calculateAutomaticMaximum, delete t.calculateAutomaticMinimum, t.title?.content.font?.style !== void 0 && (t.title.content.font.style = t.title.content.font.style.toLowerCase()), t;
   })), e;
 }
 function ue(r) {
   const e = n(r);
-  return B(r.series) || (e.series = r.series.map((i, t) => {
+  return h(r.series) || (e.series = r.series.map((i, t) => {
     const o = i;
     i.id === void 0 && (o.id = `Series ${Date.now()}-${t}`);
-    const s = h(r.series, t);
+    const s = B(r.series, t);
     return (s === c.BarSeries || s === c.LineSeries || s === c.RadarSeries) && o.query?.outStatistics?.[0]?.statisticType === "median" && (o.query.outStatistics[0].statisticType = F.ContinuousPercentile), s === c.BarSeries && o.multipleBarType !== void 0 && (o.stackedType = o.multipleBarType, delete o.multipleBarType), s === c.PieSeries && o.sliceGrouping !== void 0 && (o.sliceGrouping.sliceId = at.defaultGroupOfSlicesId, o.sliceGrouping.groupName !== void 0 && (o.sliceGrouping = {
       ...o.sliceGrouping,
       label: o.sliceGrouping.groupName
@@ -87,7 +87,7 @@ async function fe(r) {
     a && (s = await Ze(a, t));
   }
   if (s) {
-    const a = O(o.series), u = h(o.series), y = o.series && o.series.length > 0 && o.series[0].x.trim() === "" || u === c.GaugeSeries && !Ue(e) || a === f.PieFromFields || a === f.BarAndLineFromFields || a === f.BoxPlotMonoField || a === f.BoxPlotMonoFieldAndSplitBy || a === f.BoxPlotMultiFields || a === f.BoxPlotMultiFieldsAndSplitBy, He = u === c.ScatterSeries || u === c.HeatSeries || a === f.BarAndLineNoAggregation || a === f.BarAndLineSplitByNoAggregation || a === f.BoxPlotMonoField || a === f.BoxPlotMonoFieldAndSplitBy || a === f.BoxPlotMonoFieldAndCategory || a === f.BoxPlotMonoFieldAndCategoryAndSplitBy || a === f.PieNoAggregation;
+    const a = O(o.series), u = B(o.series), y = o.series && o.series.length > 0 && o.series[0].x.trim() === "" || u === c.GaugeSeries && !Ue(e) || a === f.PieFromFields || a === f.BarAndLineFromFields || a === f.BoxPlotMonoField || a === f.BoxPlotMonoFieldAndSplitBy || a === f.BoxPlotMultiFields || a === f.BoxPlotMultiFieldsAndSplitBy, He = u === c.ScatterSeries || u === c.HeatSeries || a === f.BarAndLineNoAggregation || a === f.BarAndLineSplitByNoAggregation || a === f.BoxPlotMonoField || a === f.BoxPlotMonoFieldAndSplitBy || a === f.BoxPlotMonoFieldAndCategory || a === f.BoxPlotMonoFieldAndCategoryAndSplitBy || a === f.PieNoAggregation;
     if (o.series = e.series.map((l) => {
       const d = { ...l };
       if (y || (d.x = b({ queryObject: s, fieldToMatch: l.x })), "y" in d && He) {
@@ -152,7 +152,7 @@ async function fe(r) {
 }
 function pe(r) {
   const e = n(r);
-  if (!B(r.series) && h(r.series) === c.BoxPlotSeries) {
+  if (!h(r.series) && B(r.series) === c.BoxPlotSeries) {
     const t = e.series[0];
     t && (t.showOutliers !== void 0 && (r.showOutliers === void 0 && (e.showOutliers = t.showOutliers), delete t.showOutliers), t.standardizeValues !== void 0 && (r.standardizeValues === void 0 && (e.standardizeValues = t.standardizeValues), delete t.standardizeValues), t.showMean !== void 0 && (r.showMean === void 0 && (e.showMean = t.showMean), delete t.showMean));
   }
@@ -176,7 +176,7 @@ function me(r) {
 }
 function ge(r) {
   const e = n(r);
-  if (!B(e.series) && h(r.series) === c.BoxPlotSeries) {
+  if (!h(e.series) && B(r.series) === c.BoxPlotSeries) {
     if (e.orderOptions?.data === void 0) {
       const t = ye(r.series[0]);
       t.orderType !== void 0 && (e.orderOptions ??= {}, e.orderOptions.data = {
@@ -186,7 +186,7 @@ function ge(r) {
     }
     if (e.series = r.series.map((t) => {
       const o = t;
-      return B(o.x?.trim()) && (o.x = dt), delete o.query?.orderByFields, o;
+      return h(o.x?.trim()) && (o.x = dt), delete o.query?.orderByFields, o;
     }), me(e)) {
       e.showMean = !0;
       const t = e.series.find(
@@ -211,21 +211,21 @@ function ve(r) {
   const e = n(r);
   return "dataSource" in e && e.dataSource.layer && (e.iLayer = e.dataSource.layer, delete e.dataSource), e;
 }
-function Be(r) {
+function he(r) {
   const e = n(r), i = /* @__PURE__ */ new Set(), t = e.id ?? "";
   return i.add(t), e.series.forEach((o) => {
     let s = o.id;
     i.has(s) && (s = `${s}_${Date.now()}`, o.id = s), i.add(s);
   }), e;
 }
-async function he(r) {
+async function Be(r) {
   const { configToUpdate: e, layer: i, chartContainer: t, abortSignal: o } = r;
   let s = n(e);
   if (s = ce(s), s = ue(s), s = await fe({ configToUpdate: s, layer: i, abortSignal: o }), ne(s)) {
     const a = pe(s);
     s = ge(a);
   }
-  return s = Se(s), s = Be(s), ae(s) && !ut(i) && (s = le({ configToUpdate: s, chartContainer: t, layer: i })), s;
+  return s = Se(s), s = he(s), ae(s) && !ut(i) && (s = le({ configToUpdate: s, chartContainer: t, layer: i })), s;
 }
 function Ce(r) {
   const e = n(r), i = e.series[0];
@@ -251,7 +251,7 @@ function be(r) {
 }
 function Fe(r) {
   const e = n(r);
-  if (!B(r.series) && e.axes?.[0] !== void 0 && h(r.series) === c.GaugeSeries && r.axes?.[0] !== void 0) {
+  if (!h(r.series) && e.axes?.[0] !== void 0 && B(r.series) === c.GaugeSeries && r.axes?.[0] !== void 0) {
     const t = r.axes[0];
     t.ticks !== void 0 && Object.hasOwn(t.ticks, "spacing") && delete t.ticks.spacing, e.axes[0] = t;
   }
@@ -268,13 +268,13 @@ function Te(r) {
 }
 function U(r) {
   const e = n(r);
-  return B(r.series) || (rt(r) && r.rotated === void 0 && (e.rotated = r.series[0].rotated ?? lt()), e.series.forEach((i) => {
+  return h(r.series) || (rt(r) && r.rotated === void 0 && (e.rotated = r.series[0].rotated ?? lt()), e.series.forEach((i) => {
     i.rotated !== void 0 && delete i.rotated;
   })), e;
 }
 function xe(r) {
   const e = n(r), i = r.dataSource;
-  return "dataSource" in e && !B(i) && (i.type === "featureLayer" && e.dataSource !== void 0 && (e.dataSource.type = "layer"), "featureLayer" in i && (e.dataSource.layer = i.featureLayer, delete e.dataSource.featureLayer)), e;
+  return "dataSource" in e && !h(i) && (i.type === "featureLayer" && e.dataSource !== void 0 && (e.dataSource.type = "layer"), "featureLayer" in i && (e.dataSource.layer = i.featureLayer, delete e.dataSource.featureLayer)), e;
 }
 function Oe(r) {
   const e = n(r);
@@ -310,7 +310,7 @@ function ee(r) {
 }
 function Pe(r) {
   const e = n(r);
-  if (!B(r.series) && h(r.series) === c.PieSeries) {
+  if (!h(r.series) && B(r.series) === c.PieSeries) {
     const t = e.series[0];
     if (t) {
       if (t.sortLabelsBy === "originalValue")
@@ -326,7 +326,7 @@ function Pe(r) {
 }
 function Le(r) {
   const e = n(r);
-  return B(r.series) || (ot(r) && r.stackedType === void 0 && (e.stackedType = r.series[0].stackedType ?? ct()), e.series.forEach((i) => {
+  return h(r.series) || (ot(r) && r.stackedType === void 0 && (e.stackedType = r.series[0].stackedType ?? ct()), e.series.forEach((i) => {
     "stackedType" in i && delete i.stackedType;
   })), e;
 }
@@ -387,7 +387,7 @@ function Ie(r) {
 function P(r) {
   let e, i = r.orderOptions?.orderByFields?.[0];
   if (r.series?.length > 0) {
-    const t = h(r.series), o = O(r.series);
+    const t = B(r.series), o = O(r.series);
     if (t !== c.PieSeries && o !== f.BarAndLineFromFields && (i = i ?? r.series[0].x), i && !de(i)) {
       const { fieldToSort: s, orderBy: a } = k(i);
       let u;
@@ -410,7 +410,7 @@ function We(r) {
     }), t.sortLabelsBy === "originalValue" || s.orderOptions?.data?.preferDataLabel === !1 || a.orderOptions?.data?.preferLabel === !1)
       e.orderOptions?.data && delete e.orderOptions.data;
     else if (e.orderOptions?.data === void 0)
-      if (h(e.series) === c.BoxPlotSeries) {
+      if (B(e.series) === c.BoxPlotSeries) {
         if (t.sortLabelsBy || o.sortOptions?.sortDataBy !== void 0) {
           const y = ee(o.sortOptions?.sortDataBy?.sortType);
           y && y !== p.MultiAxes && (e.orderOptions ??= {}, e.orderOptions.data = {
@@ -579,11 +579,11 @@ function J(r) {
 }
 function K(r) {
   let e = n(r);
-  return e = Bt(e), e;
+  return e = ht(e), e;
 }
 function X(r) {
   let e = n(r);
-  return h(e.series) === c.BarSeries && (e = Ce(e)), e;
+  return B(e.series) === c.BarSeries && (e = Ce(e)), e;
 }
 function ze(r) {
   const { versionsToConvert: e, configToUpdate: i } = r;
@@ -664,7 +664,7 @@ async function Dt(r, e, i, t) {
   let o = r;
   if (r) {
     const s = Ye(e);
-    await s?.load({ signal: t }), o = await he({ configToUpdate: r, layer: s, chartContainer: i, abortSignal: t });
+    await s?.load({ signal: t }), o = await Be({ configToUpdate: r, layer: s, chartContainer: i, abortSignal: t });
     const a = r.version ?? se, { versionStatus: u, versions: y } = Je(a);
     (u === re.Older || u === re.Unrecognized) && (o = ze({
       versionsToConvert: y,
@@ -688,7 +688,7 @@ const Mt = {
   movePieSeriesSortLabelsPropToChart: Pe,
   getProBoxPlotSortDataOption: ye,
   isBoxPlotConfigWithMeanLinesFromPro: me,
-  preventDuplicatedIds: Be,
+  preventDuplicatedIds: he,
   adjustBoxPlotConfig: ge,
   convertSortSeriesByToObject: we,
   moveBoxPlotSortDataByProp: De,
@@ -705,7 +705,7 @@ const Mt = {
   convertTemporalBinningProps: Ee,
   convertRESTStatisticTypeToWebChartStatisticType: Ne,
   renameChartSubtitle: Ve,
-  applyMandatoryConversions: he,
+  applyMandatoryConversions: Be,
   convertTo1x0x1: je,
   convertTo2x0x0: w,
   convertTo3x5x0: A,

package/dist/utils/data/categorical-data/index.d.ts

@@ -27,4 +27,4 @@ export function uniqueValues(props: {
     errorStrings: ErrorStrings;
     abortKey?: AbortControllerKeyType;
     abortSignal?: AbortSignal;
-}): Promise<Map<number | string, number>>;
+}): Promise<(number | string)[]>;

package/dist/utils/data/index.d.ts

@@ -240,8 +240,7 @@ export function sanitizeData(props: {
 }): WebChartDataTypes | undefined;
 
 /**
- * Fetches data from a list of OIDs. If the chart is non aggregated we directly read the OIDs stored in the data context,
- * and if the chart is aggregated we perform queries to fetch the data.
+ * Fetches data from a list of OIDs. If the ids are stored within the chart's data we directly use them, otherwise we perform queries to find the matching data items.
  *
  * @param props - A snapshot of the updated props, used to determine whether the selection OIDs have changed
  * @internal