@arcgis/charts-components 5.2.0-next.13 → 5.2.0-next.131

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

@@ -15,6 +15,8 @@ export abstract class ChartModelBase extends EventTarget {
   get chartType(): ChartTypes;
   /** Data store object that can be used to store any data needed for the chart. */
   dataStore: any;
+  /** The current revision number of the chart configuration. Increments with each update. */
+  get revision(): number;
   /** Generate the proper chart title from the current config. */
   abstract generateChartTitle(): string;
   /**
@@ -23,6 +25,14 @@ export abstract class ChartModelBase extends EventTarget {
    * @param otherModel - The other chart model to compare to.
    */
   isSameChartAs(otherModel: ChartModel | undefined): boolean;
+  /**
+   * Recalls a previous chart configuration based on its revision number. Returns `undefined` if the requested revision is not available (beyond the stored history limit).
+   *
+   * If no `configRevision` number is provided, it recalls the last configuration just before the current one.
+   *
+   * @param configRevision
+   */
+  recall(configRevision?: number): ChartConfig | undefined;
   /**
    * Completes the async setup process for the chart model. Must be called before using the model.
    *

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

@@ -0,0 +1,24 @@
+import type { WebChart } from "../../spec/web-chart.js";
+
+/**
+ * A lightweight wrapper for a `WebChart` config that has a similar shape to a `ChartModel`. Just used internally for the case where the chart component receives a raw `WebChart` config instead of a full `ChartModel` instance.
+ *
+ *  \@private
+ */
+export class ChartModelWrapper extends EventTarget {
+  constructor(config: WebChart | undefined);
+  asyncUpdatesPromise: Promise<void>;
+  /** The current chart configuration object. */
+  accessor config: WebChart | undefined;
+  get layer(): undefined;
+  /** The current revision number of the chart configuration. Increments with each update. */
+  get revision(): number;
+  /**
+   * Recalls a previous chart configuration based on its revision number. Returns `undefined` if the requested revision is not available (beyond the stored history limit).
+   *
+   * If no `configRevision` number is provided, it recalls the last configuration just before the current one.
+   *
+   * @param configRevision
+   */
+  recall(configRevision?: number): WebChart | undefined;
+}

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`.
    *
@@ -46,6 +47,7 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
   getSeriesLineWidth(seriesIndex: number): number | undefined;
   /**
    * Gets the marker color of the series based on the series index.
+   *
    * If the index is out of bounds, it will return `undefined`.
    *
    * @param seriesIndex - The index of the series.
@@ -84,10 +86,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,22 +100,31 @@ 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.
    *
    * @param smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
+  setLineSmoothed(smoothed: 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.
    *
    * @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;
@@ -121,33 +134,35 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    * **Note:** This method will only work if the series is a bar chart series.
    *
    * @param hide - The value for hiding oversized labels.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex: number): void;
+  setSeriesHideOversizedSideBySideLabels(hide: boolean | undefined, seriesIndex?: number): void;
   /**
    * Sets whether to hide oversized data labels of the stacked series based on the series index.
    * **Note:** This method will only work if the series is a bar chart series.
    *
    * @param hide - The value for hiding oversized stacked labels.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex: number): void;
+  setSeriesHideOversizedStackedLabels(hide: boolean | undefined, seriesIndex?: number): void;
   /**
    * Sets the line style of the series based on the series index.
+   *
    * **Note**: This method will only work if the series is a line chart series.
    *
    * @param newStyle - The new style for the series.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesLineStyle(newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
+  setSeriesLineStyle(newStyle: RESTSimpleLineSymbolStyle | undefined, seriesIndex?: number): void;
   /**
    * Sets the line width of the series based on the series index.
+   *
    * **Note**: This method will only work if the series is a line chart series.
    *
    * @param newWidth - The new width for the series.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesLineWidth(newWidth: number | undefined, seriesIndex: number): void;
+  setSeriesLineWidth(newWidth: number | undefined, seriesIndex?: number): void;
   /**
    * Sets the marker color of the series based on the series index.
    * **Note**: This method will only work if the series is a line chart series.
@@ -161,17 +176,17 @@ export class ComboBarLineChartModel extends ComboBarLineChartModelSuperclass {
    * **Note:** This method will only work if the series is a line chart series.
    *
    * @param newSize - The new size for the series.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesMarkerSize(newSize: number | undefined, seriesIndex: number): void;
+  setSeriesMarkerSize(newSize: number | undefined, seriesIndex?: number): void;
   /**
    * Sets the marker style of the series based on the series index.
    * **Note:** This method will only work if the series is a line chart series.
    *
    * @param newStyle - The new style for the series.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesMarkerStyle(newStyle: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number): void;
+  setSeriesMarkerStyle(newStyle: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex?: number): void;
   /**
    * Changes the chart series type at the specified index from bar to line and vice-versa.
    *
@@ -186,4 +201,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

@@ -32,7 +32,13 @@ export class HeatChartModel extends SerialChartModel {
   accessor classificationMethod: WebChartClassBreakTypes | undefined;
   /** The name of the color ramp used by the heat chart. */
   accessor colorRampName: string | undefined;
-  /** The heat chart's empty cell configuration. */
+  /**
+   * Gets the heat chart's empty cell configuration
+   *
+   * @deprecated
+   * since 5.2 Use [emptyCellText](https://developers.arcgis.com/javascript/latest/references/charts-components/model/heat-chart-model/heat-chart-model/#emptyCellText) or [emptyCellSymbol](https://developers.arcgis.com/javascript/latest/references/charts-components/model/heat-chart-model/heat-chart-model/#emptyCellSymbol) to retrieve the text or symbol for an empty heat chart cell instead.
+   * This property will be removed from `HeatChartModel` in 6.0
+   */
   accessor emptyCell: WebChartHeatChartEmptyCell | undefined;
   /** The heat chart's empty cell symbol. */
   accessor emptyCellSymbol: ISimpleFillSymbol | undefined;
@@ -164,8 +170,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 +202,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 +214,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 +251,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/chart-interfaces.d.ts

@@ -1,20 +1,23 @@
-import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
+import type { ChartLayerInputSansView } from "../../interfaces.js";
 import type { IFeatureLayer, IImageServiceLayer, ITiledImageServiceLayer } from "../../spec/rest-js-types.js";
 import type { WebChartBarChartSeries, WebChartHeatChartSeries, WebChartLineChartSeries, WebChartRadarChartSeries } from "../../spec/web-chart.js";
 import type { CommonStrings } from "../../utils/localization/interfaces.js";
 import type { ChartConfig } from "../../utils/types/index.js";
+import type { ChartElementLimit } from "../../utils/defaults/interfaces.js";
 import type { ModelTypes } from "./common.js";
 
 /** Parameters for creating a chart model. */
 export type ModelParams<T extends ChartConfig> = {
   /** Layer instance associated with the chart. */
-  layer?: SupportedLayer | SupportedRasterLayer;
+  layer?: ChartLayerInputSansView;
   /** Layer description to be used when the `layer` property is not set. */
   iLayer?: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer;
   /** Chart config object to be edited. If not provided, a new config will be created using default values. */
   config?: T;
   /** t9n error strings */
   commonStrings?: CommonStrings;
+  /** Maximum number of chart elements allowed while building the model. */
+  chartLimits?: ChartElementLimit;
 };
 
 /** Type alias for the supported serial chart config. */

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

@@ -1,4 +1,4 @@
-import type { SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
+import type { ChartLayerInputSansView } from "../../interfaces.js";
 import type { WebChartTypes } from "../../spec/chart-object-literals.js";
 import type { IField } from "../../spec/rest-js-types.js";
 import type { WebChartBarChartSeries, WebChartBoxPlotSeries, WebChartGaugeSeries, WebChartHeatChartSeries, WebChartHistogramSeries, WebChartLineChartSeries, WebChartPieChartSeries, WebChartRadarChartSeries, WebChartScatterplotSeries } from "../../spec/web-chart.js";
@@ -127,6 +127,8 @@ export type GuideOrientation = (typeof GuideOrientation)[keyof typeof GuideOrien
 
 export interface SplitByFieldInfos {
   categoriesArray: (number | string)[];
+  seriesLimitReached: boolean;
+  totalSeriesCount: number;
   splitByFieldType?: string;
   numericalField: string;
 }
@@ -141,7 +143,7 @@ export interface PieSeriesDisplayOptions {
 
 export interface LayerInfo {
   /** Layer used for this bar chart. */
-  layer: SupportedLayer | SupportedRasterLayer;
+  layer: ChartLayerInputSansView;
   /** Fields information for the layer. */
   layerFieldsInfo: IField[];
   /** Object ID field name for the layer. */

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;
@@ -133,8 +133,8 @@ export abstract class ModelWithGuides extends ChartModel {
    * Sets whether the tooltip text color should be reversed for a guide.
    *
    * @param reverseColor - New reverseColor boolean to set.
-   * @param index - 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 - The axis orientation of the guide.
    */
-  setTooltipReverseColor(reverseColor: boolean, index: number, orientation?: GuideOrientation): void;
+  setTooltipReverseColor(reverseColor: 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,28 +77,36 @@ 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`.
    *
-   * @param connect - Whether to connect the gap in the data
-   * @param seriesIndex - The index of the series.
+   * @param connect - Whether to connect the gap in the data.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setConnectLines(connect: boolean | undefined, seriesIndex: number): void;
+  setConnectLines(connect: boolean | undefined, seriesIndex?: number): void;
   /**
    * Specify whether line segments of the series should be smoothed.
    *
    * @param smoothed - `true` if line segment of the series should be smoothed, `false` otherwise.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setLineSmoothed(smoothed: boolean, seriesIndex: number): void;
+  setLineSmoothed(smoothed: boolean, seriesIndex?: number): void;
   /**
    * 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;
@@ -105,16 +114,16 @@ export abstract class ModelWithLineMarkerStyling extends ChartModel {
    * Sets the line style of the series based on the series index.
    *
    * @param style - The new style for the series.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesLineStyle(style: RESTSimpleLineSymbolStyle | undefined, seriesIndex: number): void;
+  setSeriesLineStyle(style: RESTSimpleLineSymbolStyle | undefined, seriesIndex?: number): void;
   /**
    * Sets the line width of the series based on the series index.
    *
    * @param width - The new width for the series.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesLineWidth(width: number | undefined, seriesIndex: number): void;
+  setSeriesLineWidth(width: number | undefined, seriesIndex?: number): void;
   /**
    * Sets the marker color of the series based on the series index.
    *
@@ -126,14 +135,14 @@ export abstract class ModelWithLineMarkerStyling extends ChartModel {
    * Sets the marker size of the series based on the series index.
    *
    * @param size - The new size for the series.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesMarkerSize(size: number | undefined, seriesIndex: number): void;
+  setSeriesMarkerSize(size: number | undefined, seriesIndex?: number): void;
   /**
    * Sets the marker style of the series based on the series index.
    *
    * @param style - The new style for the series.
-   * @param seriesIndex - The index of the series.
+   * @param seriesIndex - The index of the series. If omitted, all compatible series will be updated.
    */
-  setSeriesMarkerStyle(style: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex: number): void;
+  setSeriesMarkerStyle(style: RESTSimpleMarkerSymbolStyle | undefined, seriesIndex?: number): void;
 }