@arcgis/charts-components 5.2.0-next.8 → 5.2.0-next.85

package/dist/model/combo-bar-line-chart-model/combo-bar-line-chart-model.d.ts

@@ -1,5 +1,6 @@
 import type { ModelParams } from "../interfaces/chart-interfaces.js";
 import type { ModelTypes } from "../interfaces/common.js";
+import type { WithRoundedCorners } from "../properties/rounded-corners.js";
 import type { WithNegativeValuesStackedToBaseline } from "../properties/series/negative-values-stacked-to-baseline.js";
 import type { SerialChartModel } from "../serial-chart-model/serial-chart-model.js";
 import type { WebChartTypes } from "../../spec/chart-object-literals.js";
@@ -16,7 +17,7 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    */
   getAreaColor(seriesIndex: number): Color | undefined;
   /**
-   * Gets whether to hide oversized data labels of the side-by-side series based on the series index. '
+   * Gets whether to hide oversized data labels of the side-by-side series based on the series index.
    *
    * If the index is out of bounds, it will return `undefined`.
    *
@@ -84,10 +85,12 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    */
   isMarkerVisible(seriesIndex: number): boolean;
   /**
-   * Specify the color of the filled area for line chart.
-   * **Note:** This method will only work if the series is a line chart series.
+   * Specify the color of the filled area.
+   *
+   * **Note:** This method will only work if the series is a line series.
+   * **Note:** `color` will be applied only if [`setAreaVisible`](#setareavisible) is true, and is defaulted to the line color if not provided.
    *
-   * @param color - The color of the filled area for line chart.
+   * @param color - The color of the filled area.
    * @param seriesIndex - The index of the series.
    */
   setAreaColor(color: Color | undefined, seriesIndex: number): void;
@@ -96,9 +99,9 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    * **Note:** This method will only work if the series is a line chart series.
    *
    * @param visible - `true` if the line series should show area, `false` otherwise.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setAreaVisible(visible: boolean, seriesIndex: number): void;
+  setAreaVisible(visible: boolean, seriesIndex?: number): void;
   /**
    * Specify whether line segments of the series should be smoothed.
    * **Note:** This method will only work if the series is a line chart series.
@@ -112,6 +115,15 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    * **Note:** This method will only work if the series is a line chart series.
    *
    * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
+   */
+  setMarkersVisible(visible: boolean, seriesIndex?: number): void;
+  /**
+   * Indicate whether to show or hide the markers/bullets of the line series.
+   * **Note:** This method will only work if the series is a line chart series.
+   *
+   * @deprecated since 5.2. Use [setMarkersVisible](https://developers.arcgis.com/javascript/latest/references/charts-components/model/combo-bar-line-chart-model/combo-bar-line-chart-model/#setMarkersVisible) instead. This method will be removed from `ComboBarLineChartModel` in 6.0.
+   * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
    * @param seriesIndex - The index of the series.
    */
   setMarkerVisible(visible: boolean, seriesIndex: number): void;
@@ -186,4 +198,4 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.ComboBarLineChart>>): Promise<void>;
 }
-declare const ComboBarLineChartModelSuperclass: typeof SerialChartModel & typeof WithNegativeValuesStackedToBaseline
+declare const ComboBarLineChartModelSuperclass: typeof SerialChartModel & typeof WithRoundedCorners & typeof WithNegativeValuesStackedToBaseline

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

@@ -164,8 +164,21 @@ export class HeatChartModel extends SerialChartModel {
   generateChartTitle(): string;
   /** Generate the proper y-axis title given the current config. */
   generateYAxisTitle(): string;
+  /**
+   * The heat chart's second axis (not supported)
+   *
+   * @deprecated since 5.2. Use [getSeriesToSecondaryYAxis](https://developers.arcgis.com/javascript/latest/references/charts-components/model/heat-chart-model/heat-chart-model/#getSeriesToSecondaryYAxis) instead.
+   * @internal
+   */
+  getAssignToSecondValueAxis(): boolean;
   /** Gets the grid lines symbol. Contains styling information such as line width, line style, and line color. */
   getGridLinesSymbol(): ISimpleLineSymbol | undefined;
+  /**
+   * The heat chart's secondary y-axis (not supported)
+   *
+   * @internal
+   */
+  getSeriesToSecondaryYAxis(): boolean;
   /** Gets the sort order for the bar chart. */
   getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
   /**
@@ -183,6 +196,7 @@ export class HeatChartModel extends SerialChartModel {
   /**
    * The heat chart's second axis (not supported)
    *
+   * @deprecated since 5.2. Use [setSeriesToSecondaryYAxis](https://developers.arcgis.com/javascript/latest/references/charts-components/model/heat-chart-model/heat-chart-model/#setSeriesToSecondaryYAxis) instead.
    * @param _assign
    * @param _seriesIndex
    * @internal
@@ -194,15 +208,34 @@ export class HeatChartModel extends SerialChartModel {
    * @param linesSymbol - The grid lines symbol.
    * @example
    * ```ts
-   * heatChartModel.setGridLinesSymbol({
-   *  type: "esriSLS",
-   *  style: "esriSLSDash",
-   *  color: [255, 100, 100, 255],
-   *  width: 3,
-   * });
+   * // 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): void;
+  /**
+   * The heat chart's secondary y-axis (not supported)
+   *
+   * @param _assign
+   * @param _seriesIndex
+   * @internal
+   * @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;
   /**
    * setSortOrder is not used by heat chart; instead use setXAxisSortOrder for the x axis and setYAxisSortOrder for the y axis.
    *
@@ -212,9 +245,9 @@ export class HeatChartModel extends SerialChartModel {
    */
   setSortOrder(_newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, _orderByList?: string[]): void;
   /**
-   * Completes the async setup process for the chart model. Must be called before using the model.
+   * Sets up the heat chart model from the provided model params.
    *
-   * @param params
+   * @param params - ModelTypes.HeatChart>>} params - The model setup params.
    */
   setup(params: ModelParams<ChartConfig<typeof ModelTypes.HeatChart>>): Promise<void>;
   /**

package/dist/model/interfaces/common.d.ts

@@ -163,11 +163,9 @@ export const ModelTypes: {
 
 export type ModelTypes = (typeof ModelTypes)[keyof typeof ModelTypes];
 
-/** @internal */
 export type ModelTypeToSeriesType<T extends ModelTypes> = T extends typeof ModelTypes.BarChart ? WebChartBarChartSeries : T extends typeof ModelTypes.LineChart ? WebChartLineChartSeries : T extends typeof ModelTypes.ComboBarLineChart ? WebChartBarChartSeries | WebChartLineChartSeries : T extends typeof ModelTypes.BoxPlot ? WebChartBoxPlotSeries | WebChartLineChartSeries : T extends typeof ModelTypes.PieChart ? WebChartPieChartSeries : T extends typeof ModelTypes.Scatterplot ? WebChartScatterplotSeries : T extends typeof ModelTypes.Histogram ? WebChartHistogramSeries : T extends typeof ModelTypes.Gauge ? WebChartGaugeSeries : T extends typeof ModelTypes.RadarChart ? WebChartRadarChartSeries : T extends typeof ModelTypes.HeatChart ? WebChartHeatChartSeries : SupportedChartSeries;
 
 /** @internal */
 export type SeriesTypeToChartType<T extends SupportedChartSeries> = T extends WebChartBarChartSeries ? typeof WebChartTypes.BarSeries : T extends WebChartLineChartSeries ? typeof WebChartTypes.LineSeries : T extends WebChartBoxPlotSeries ? typeof WebChartTypes.BoxPlotSeries : T extends WebChartPieChartSeries ? typeof WebChartTypes.PieSeries : T extends WebChartScatterplotSeries ? typeof WebChartTypes.ScatterSeries : T extends WebChartHistogramSeries ? typeof WebChartTypes.HistogramSeries : T extends WebChartGaugeSeries ? typeof WebChartTypes.GaugeSeries : T extends WebChartRadarChartSeries ? typeof WebChartTypes.RadarSeries : T extends WebChartHeatChartSeries ? typeof WebChartTypes.HeatSeries : never;
 
-/** @internal */
 export type ModelOfType<T> = T extends typeof ModelTypes.BarChart ? BarChartModel : T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : T extends typeof ModelTypes.HeatChart ? HeatChartModel : never;

package/dist/model/mixins/model-with-guides.d.ts

@@ -125,7 +125,7 @@ export abstract class ModelWithGuides extends ChartModel {
    * Sets whether a guide is visible.
    *
    * @param visible - New visibility to set.
-   * @param index - Default `0`. The index of the guide in the list of guides for the given axis orientation.
+   * @param index - The index of the guide in the list of guides for the given axis orientation. If omitted, all guides for the orientation will be updated.
    * @param orientation - Default `y`. The axis orientation of the guide.
    */
   setGuideVisibility(visible: boolean, index?: number, orientation?: GuideOrientation): void;

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

@@ -4,14 +4,13 @@ import type { Color } from "../../spec/rest-js-types.js";
 
 export abstract class ModelWithLineMarkerStyling extends ChartModel {
   /**
-   * 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.
+   * Get the color of the filled area.
    *
    * @param seriesIndex - The index of the series.
    */
   getAreaColor(seriesIndex: number): Color | undefined;
   /**
-   * Specify the color of the filled area for line chart.
+   * Get whether to connect the lines when there's a gap in the data.
    *
    * @param seriesIndex - The index of the series.
    */
@@ -66,9 +65,11 @@ export abstract class ModelWithLineMarkerStyling extends ChartModel {
    */
   isMarkerVisible(seriesIndex: number): boolean;
   /**
-   * Specify the color of the filled area for line chart.
+   * Specify the color of the filled area.
    *
-   * @param color - The color of the filled area for line chart.
+   * **Note:** `color` will be applied only if [`setAreaVisible`](#setareavisible) is true, and is defaulted to the line color if not provided.
+   *
+   * @param color - The color of the filled area.
    * @param seriesIndex - The index of the series.
    */
   setAreaColor(color: Color | undefined, seriesIndex: number): void;
@@ -76,9 +77,9 @@ export abstract class ModelWithLineMarkerStyling extends ChartModel {
    * Specify whether the line series should show area.
    *
    * @param visible - `true` if the line series should show area, `false` otherwise.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setAreaVisible(visible: boolean, seriesIndex: number): void;
+  setAreaVisible(visible: boolean, seriesIndex?: number): void;
   /**
    * Specify whether to connect the lines when there's a gap in the data.
    * **Note:** Can be overridden by the temporal data setting `nullPolicy`.
@@ -98,6 +99,14 @@ export abstract class ModelWithLineMarkerStyling extends ChartModel {
    * Indicate whether to show or hide the markers/bullets of the line series.
    *
    * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
+   */
+  setMarkersVisible(visible: boolean, seriesIndex?: number): void;
+  /**
+   * Indicate whether to show or hide the markers/bullets of the line series.
+   *
+   * @deprecated since 5.2. Use [setMarkersVisible](https://developers.arcgis.com/javascript/latest/references/charts-components/model/mixins/model-with-line-marker-styling/#setMarkersVisible) instead. This method will be removed from `ModelWithLineMarkerStyling` in 6.0.
+   * @param visible - `true` if the markers/bullets of the line series should be shown, `false` otherwise.
    * @param seriesIndex - The index of the series.
    */
   setMarkerVisible(visible: boolean, seriesIndex: number): void;

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 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.
-   */
+  /** 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 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.
    */
   accessor cursorCrosshairHorizontalLineVisibility: 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.
-   */
+  /** 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 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.
    */
   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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.
+   * - 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 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 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 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.
+   * - 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 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 linesSymbol - The grid lines symbol.
-   * @param axisIndices - The indices of the axes to set the grid lines symbol for.
+   * @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 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.
    */
   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 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.
+   * - 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 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 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 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 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 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 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 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 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 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.
    */