ESM

import { ModelWithMultiAxes } from "@arcgis/charts-components/model/mixins/model-with-multi-axes.js";

Inheritance: ModelWithMultiAxes→chart-model→chart-model-base→EventTarget

Subclasses: serial-chart-model, box-plot-model, histogram-model, scatterplot-model

Constructors

Constructor

inherited Constructor

Inherited from: ChartModelBase

Parameters

Parameter	Type	Description	Required
args	any[]

Properties

Property	Type	Class
asyncUpdatesPromise inherited	Promise<void>	ChartModelBase
backgroundColor inherited	Color \| undefined	WithBackgroundColor
chartId inherited	string \| undefined	WithChartId
chartRenderer inherited	IDrawingInfo["renderer"] \| undefined	WithChartRenderer
chartSubtitleVisibility inherited	boolean	WithChartSubtitleVisibility
chartSubType readonly inherited	ChartSubType	WithChartSubType
chartTitleVisibility inherited	boolean	WithChartTitleVisibility
chartType readonly inherited	ChartTypes	ChartModelBase
config inherited	ChartConfig	WithConfig
cursorCrosshair	WebChartCursorCrosshair \| undefined
cursorCrosshairHorizontalLineVisibility	boolean
cursorCrosshairStyle	ISimpleLineSymbol \| undefined
cursorCrosshairVerticalLineVisibility	boolean
dataStore inherited	any	ChartModelBase
descriptionSymbol inherited	WebChartTextSymbol \| undefined	WithDescriptionSymbol
descriptionText inherited	string	WithDescriptionText
descriptionVisibility inherited	boolean	WithDescriptionVisibility
fetchNULLValues inherited	boolean	WithFetchNULLValues
layer readonly inherited	SupportedLayer \| SupportedRasterLayer \| undefined	WithLayer
revision readonly inherited	number	ChartModelBase
seriesLength readonly inherited	number	WithSeriesLength
splitByValues readonly inherited	string[]	WithSplitByValues
subtitleSymbol inherited	WebChartTextSymbol \| undefined	WithSubtitleSymbol
subtitleText inherited	string	WithSubtitleText
titleSymbol inherited	WebChartTextSymbol \| undefined	WithTitleSymbol
titleText inherited	string	WithTitleText
version readonly inherited	string \| undefined	WithVersion

asyncUpdatesPromise

inherited Property

Type: Promise<void>

Inherited from: ChartModelBase

Promise that resolves when the setup process is complete.

Note: This promise does not need to be awaited if the setup method has already been awaited. It is simply provided as a way to await the setup process from other functions if needed to avoid race conditions.

backgroundColor

inherited Property

Type: Color | undefined

Inherited from: WithBackgroundColor

The background color of the chart.

chartId

inherited Property

Type: string | undefined

Inherited from: WithChartId

The chart ID.

chartRenderer

autocast inherited Property

Type: IDrawingInfo["renderer"] | undefined

Inherited from: WithChartRenderer

The chart renderer.

Example

In this example, we set the chartRenderer for a class-break heat chart.

heatChartModel.chartRenderer = {
   "type": "classBreaks",
   "field": "arcgis_charts_heat_chart_value",
   "classBreakInfos": [
       {
         "label": "70 - 145",
         "classMinValue": 70,
         "classMaxValue": 145,
         "symbol": {
           "type": "esriSFS",
           "color": [
             212,
             227,
             255,
             255
           ],
           "style": "esriSFSSolid"
         }
       },
       {
         "label": "146 - 250",
         "classMinValue": 146,
         "classMaxValue": 250,
         "symbol": {
           "type": "esriSFS",
           "color": [
             43,
             108,
             240,
             255
           ],
           "style": "esriSFSSolid"
         }
       }
   ]
 };

chartSubtitleVisibility

inherited Property

Type: boolean

Inherited from: WithChartSubtitleVisibility

Whether or not the chart subtitle is visible.

Note: Even if the subtitle is visible, it may not be displayed if the subtitle text is empty.

chartSubType

readonlyinherited Property

Type: ChartSubType

Inherited from: WithChartSubType

The chart sub type of the series.

chartTitleVisibility

inherited Property

Type: boolean

Inherited from: WithChartTitleVisibility

Whether or not the chart title is visible.

Note: Even if the title is visible, it may not be displayed if the title text is empty.

chartType

readonlyinherited Property

Type: ChartTypes

Inherited from: ChartModelBase

The chart type.

config

inherited Property

Type: ChartConfig

Inherited from: WithConfig

The current chart configuration object.

cursorCrosshair

Property

Type: WebChartCursorCrosshair | undefined

Gets the cursor crosshair.

cursorCrosshairHorizontalLineVisibility

Property

Type: boolean

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.

cursorCrosshairStyle

Property

Type: ISimpleLineSymbol | undefined

Gets the style of the cursor's crosshair.

cursorCrosshairVerticalLineVisibility

Property

Type: boolean

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.

dataStore

inherited Property

Type: any

Inherited from: ChartModelBase

Data store object that can be used to store any data needed for the chart.

descriptionSymbol

inherited Property

Type: WebChartTextSymbol | undefined

Inherited from: WithDescriptionSymbol

The description text symbol. Contains styling information such as font, color, and symbol style.

descriptionText

inherited Property

Type: string

Inherited from: WithDescriptionText

descriptionVisibility

inherited Property

Type: boolean

Inherited from: WithDescriptionVisibility

Whether or not the chart description is visible.

Note: Even if the description is visible, it may not be displayed if the description text is empty.

fetchNULLValues

inherited Property

Type: boolean

Inherited from: WithFetchNULLValues

Whether to fetch null values for them to be counted or displayed as categories on the chart.

layer

readonlyinherited Property

Type: SupportedLayer | SupportedRasterLayer | undefined

Inherited from: WithLayer

The chart model's layer.

revision

readonlyinherited Property

Type: number

Inherited from: ChartModelBase

The current revision number of the chart configuration. Increments with each update.

seriesLength

readonlyinherited Property

Type: number

Inherited from: WithSeriesLength

The length of the series array.

splitByValues

readonlyinherited Property

Type: string[]

Inherited from: WithSplitByValues

The split-by values for the chart.

subtitleSymbol

inherited Property

Type: WebChartTextSymbol | undefined

Inherited from: WithSubtitleSymbol

The subtitle text symbol. Contains styling information such as font, color, and symbol style.

subtitleText

inherited Property

Type: string

Inherited from: WithSubtitleText

The chart subtitle text.

titleSymbol

inherited Property

Type: WebChartTextSymbol | undefined

Inherited from: WithTitleSymbol

The title text symbol. Contains styling information such as font, color, and symbol style.

titleText

inherited Property

Type: string

Inherited from: WithTitleText

The chart title text.

version

readonlyinherited Property

Type: string | undefined

Inherited from: WithVersion

The version of the chart configuration.

Methods

Method	Signature	Class
generateChartTitle inherited	generateChartTitle(): string	ChartModelBase
generateYAxisTitle	generateYAxisTitle(): string
getAxisLabelsVisibility	getAxisLabelsVisibility(axisIndex: number): boolean
getAxisScrollbar	getAxisScrollbar(axisIndex: number): WebChartAxisScrollBar \| undefined
getAxisTitleSymbol	getAxisTitleSymbol(axisIndex: number): WebChartTextSymbol \| undefined
getAxisTitleText	getAxisTitleText(axisIndex: number): string
getAxisTitleVisibility	getAxisTitleVisibility(axisIndex: number): boolean
getAxisValueFormat	getAxisValueFormat(axisIndex: number): CategoryFormatOptions \| DateTimeFormatOptions \| NumberFormatOptions \| undefined
getAxisVisibility	getAxisVisibility(axisIndex: number): boolean
getBuffer	getBuffer(axisIndex: number): boolean
getDataFilters inherited	getDataFilters(): WebChartDataFilters \| undefined	WithDataFilters
getDataTooltipFontSize inherited	getDataTooltipFontSize(seriesIndex: number): number \| undefined	WithSeriesDataTooltipFontSize
getDataTooltipValueFormat inherited	getDataTooltipValueFormat(seriesIndex: number): NumberFormatOptions \| undefined	WithSeriesDataTooltipValueFormat
getDefaultXAxisTitleText	getDefaultXAxisTitleText(): string
getDisplayCursorTooltip	getDisplayCursorTooltip(axisIndex: number): boolean
getDisplayZeroLine	getDisplayZeroLine(axisIndex: number): boolean
getGridLinesSymbol	getGridLinesSymbol(): ISimpleLineSymbol \| undefined
getHorizontalAxisLabelsBehavior	getHorizontalAxisLabelsBehavior(): WebChartLabelBehavior
getIntegerOnlyValues	getIntegerOnlyValues(axisIndex: number): boolean
getLogarithmic	getLogarithmic(axisIndex: number): boolean
getMaxBound	getMaxBound(axisIndex: number): number
getMinBound	getMinBound(axisIndex: number): number
getSeriesId inherited	getSeriesId(seriesIndex: number): string \| undefined	WithSeriesId
getSeriesIndex inherited	getSeriesIndex(seriesId: string): number \| undefined	WithSeriesIndex
getSeriesVisibility inherited	getSeriesVisibility(seriesIndex: number): boolean	WithSeriesVisibility
getTickSpacing	getTickSpacing(axisIndex: number): number \| undefined
getVerticalAxisLabelsBehavior	getVerticalAxisLabelsBehavior(): WebChartLabelBehavior
isSameChartAs inherited	isSameChartAs(otherModel: ChartModel \| undefined): boolean	ChartModelBase
recall inherited	recall(configRevision?: number): ChartConfig \| undefined	ChartModelBase
setAxisLabelsVisibility	setAxisLabelsVisibility(isVisible: boolean, axisIndex?: number): void
setAxisScrollbar	setAxisScrollbar(scrollbar: WebChartAxisScrollBar, axisIndex: number): void
setAxisTitleSymbol	setAxisTitleSymbol(titleSymbol: WebChartTextSymbol \| undefined, axisIndex?: number): void
setAxisTitleText	setAxisTitleText(titleText: string, axisIndex: number): void
setAxisTitleVisibility	setAxisTitleVisibility(isVisible: boolean, axisIndex?: number): void
setAxisValueFormat	setAxisValueFormat(axisIndex: number, valueFormat?: CategoryFormatOptions \| DateTimeFormatOptions \| NumberFormatOptions): void
setAxisVisibility	setAxisVisibility(isVisible: boolean, axisIndex: number): void
setBuffer	setBuffer(buffer: boolean, axisIndex?: number): void
setDataFilters inherited	setDataFilters(newDataFilters: WebChartDataFilters \| undefined): Promise<void>	WithDataFilters
setDataTooltipFontSize inherited	setDataTooltipFontSize(fontSize: number \| undefined, seriesIndex: number): void	WithSeriesDataTooltipFontSize
setDataTooltipValueFormat inherited	setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions \| undefined): void	WithSeriesDataTooltipValueFormat
setDisplayCursorTooltip	setDisplayCursorTooltip(displayCursorTooltip: boolean, axisIndex?: number): void
setDisplayZeroLine	setDisplayZeroLine(displayZeroLine: boolean, axisIndex?: number): void
setGridLinesSymbol	setGridLinesSymbol(linesSymbol: ISimpleLineSymbol \| undefined, axisIndices?: number[]): void
setHorizontalAxisLabelsBehavior	setHorizontalAxisLabelsBehavior(horizontalBehavior: WebChartLabelBehavior): void
setIntegerOnlyValues	setIntegerOnlyValues(integerOnlyValues: boolean, axisIndex?: number): void
setLogarithmic	setLogarithmic(isLogarithmic: boolean, axisIndex: number): void
setMaxBound	setMaxBound(newMaxBound: number \| null, axisIndex: number): void
setMinBound	setMinBound(newMinBound: number \| null, axisIndex: number): void
setSeriesVisibility inherited	setSeriesVisibility(props: LegendItemVisibility): void	WithSeriesVisibility
setTickSpacing	setTickSpacing(tickSpacing: number, axisIndex: number): void
setup inherited	setup(params: ModelParams<ChartConfig>): Promise<void>	ChartModelBase
setVerticalAxisLabelsBehavior	setVerticalAxisLabelsBehavior(verticalBehavior: WebChartLabelBehavior): void
update inherited	update(): Promise<void>	ChartModelBase

generateChartTitle

inherited Method

Signature: generateChartTitle (): string

Inherited from: ChartModelBase

Generate the proper chart title from the current config.

Returns: string

generateYAxisTitle

Method

Signature: generateYAxisTitle (): string

Generate the proper y-axis title from the current config.

Returns: string

getAxisLabelsVisibility

Method

Signature: getAxisLabelsVisibility (axisIndex: number): boolean

Gets the visibility of the specified axis labels.

Parameters

Parameter	Type	Description	Required
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.

Returns: boolean

getAxisScrollbar

Method

Signature: getAxisScrollbar (axisIndex: number): WebChartAxisScrollBar | undefined

Gets the scrollbar configuration for the specified axis.

Parameters

Returns: WebChartAxisScrollBar | undefined

getAxisTitleSymbol

Method

Signature: getAxisTitleSymbol (axisIndex: number): WebChartTextSymbol | undefined

Gets the specified title text symbol. Contains styling information such as font, color, and symbol style.

Parameters

Parameter	Type	Description	Required
axisIndex	number	The index of the axis to get the title symbol for

Returns: WebChartTextSymbol | undefined

getAxisTitleText

Method

Signature: getAxisTitleText (axisIndex: number): string

Gets the title text of the specified axis.

Parameters

Returns: string

getAxisTitleVisibility

Method

Signature: getAxisTitleVisibility (axisIndex: number): boolean

Gets the visibility of the specified axis title.

Parameters

Returns: boolean

getAxisValueFormat

Method

Signature: getAxisValueFormat (axisIndex: number): CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined

Gets the value format for the specified axis.

Parameters

Returns: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions | undefined

getAxisVisibility

Method

Signature: getAxisVisibility (axisIndex: number): boolean

Gets the visibility of the specified axis.

Parameters

Returns: boolean

getBuffer

Method

Signature: getBuffer (axisIndex: number): boolean

Gets the buffer setting for the specified axis.

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.

Parameters

Returns: boolean

getDataFilters

inherited Method

Signature: getDataFilters (): WebChartDataFilters | undefined

Inherited from: WithDataFilters

Gets the data filter for the chart.

Returns: WebChartDataFilters | undefined

getDataTooltipFontSize

inherited Method

Signature: getDataTooltipFontSize (seriesIndex: number): number | undefined

Inherited from: WithSeriesDataTooltipFontSize

Gets the data tooltip font size for a series.

If the series index is out of bounds or the series list is empty, this function will return undefined.

Parameters

Parameter	Type	Description	Required
seriesIndex	number	The index of the series to retrieve the font size for.

Returns: number | undefined

getDataTooltipValueFormat

inherited Method

Signature: getDataTooltipValueFormat (seriesIndex: number): NumberFormatOptions | undefined

Inherited from: WithSeriesDataTooltipValueFormat

Gets the data tooltip value format for a series.

Parameters

Parameter	Type	Description	Required
seriesIndex	number	The index of the series to retrieve the value format for.

Returns: NumberFormatOptions | undefined

getDefaultXAxisTitleText

Method

Signature: getDefaultXAxisTitleText (): string

Get the default x-axis title text.

Returns: string

getDisplayCursorTooltip

Method

Signature: getDisplayCursorTooltip (axisIndex: number): boolean

Gets the display cursor tooltip setting for the specified axis.

If displayCursorTooltip is not set on the axis, the default value of false will be returned.

Parameters

Returns: boolean

getDisplayZeroLine

Method

Signature: getDisplayZeroLine (axisIndex: number): boolean

Gets the display zero line setting for the specified axis.

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.

Parameters

Returns: boolean

getGridLinesSymbol

Method

Signature: getGridLinesSymbol (): ISimpleLineSymbol | undefined

Gets the grid lines symbol. Contains styling information such as line width, line style, and line color.

Returns: ISimpleLineSymbol | undefined

getHorizontalAxisLabelsBehavior

Method

Signature: getHorizontalAxisLabelsBehavior (): WebChartLabelBehavior

Gets the horizontal axis labels behavior for the chart.

Returns: WebChartLabelBehavior

getIntegerOnlyValues

Method

Signature: getIntegerOnlyValues (axisIndex: number): boolean

Gets the integer only values setting for the specified axis.

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.

Parameters

Returns: boolean

getLogarithmic

Method

Signature: getLogarithmic (axisIndex: number): boolean

Gets whether logarithmic scale is enabled for the specified axis.

Parameters

Returns: boolean

getMaxBound

Method

Signature: getMaxBound (axisIndex: number): number

Gets the maximum bound for the specified axis.

Parameters

Returns: number

getMinBound

Method

Signature: getMinBound (axisIndex: number): number

Gets the minimum bound for the specified axis.

Parameters

Returns: number

getSeriesId

inherited Method

Signature: getSeriesId (seriesIndex: number): string | undefined

Inherited from: WithSeriesId

Gets the series ID for a given series index. If the series index is out of bounds, this function will return undefined.

Parameters

Parameter	Type	Description	Required
seriesIndex	number	The index of the series.

Returns: string | undefined

getSeriesIndex

inherited Method

Signature: getSeriesIndex (seriesId: string): number | undefined

Inherited from: WithSeriesIndex

Gets the series index for a given series ID. If the series ID is not found, this function will return undefined.

Parameters

Parameter	Type	Description	Required
seriesId	string	The ID of the series.

Returns: number | undefined

getSeriesVisibility

inherited Method

Signature: getSeriesVisibility (seriesIndex: number): boolean

Inherited from: WithSeriesVisibility

Gets the visibility of a series.

Parameters

Parameter	Type	Description	Required
seriesIndex	number	The series index

Returns: boolean

getTickSpacing

Method

Signature: getTickSpacing (axisIndex: number): number | undefined

Gets the tick spacing setting for the specified axis.

Parameters

Returns: number | undefined

getVerticalAxisLabelsBehavior

Method

Signature: getVerticalAxisLabelsBehavior (): WebChartLabelBehavior

Gets the vertical axis labels behavior for the chart.

Returns: WebChartLabelBehavior

isSameChartAs

inherited Method

Signature: isSameChartAs (otherModel: ChartModel | undefined): boolean

Inherited from: ChartModelBase

Checks if the current chart model is for the same chart as another chart model.

Parameters

Parameter	Type	Description	Required
otherModel	ChartModel \| undefined	The other chart model to compare to.

Returns: boolean

recall

inherited Method

Signature: recall (configRevision?: number): ChartConfig | undefined

Inherited from: ChartModelBase

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.

Parameters

Parameter	Type	Description	Required
configRevision	number

Returns: ChartConfig | undefined

setAxisLabelsVisibility

Method

Signature: setAxisLabelsVisibility (isVisible: boolean, axisIndex?: number): void

Sets the visibility of the specified axis labels.

Parameters

Parameter	Type	Description	Required
isVisible	boolean	The visibility state for the axis labels.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis. If omitted, all axes will be updated.

Returns: void

setAxisScrollbar

Method

Signature: setAxisScrollbar (scrollbar: WebChartAxisScrollBar, axisIndex: number): void

Sets the scrollbar configuration for zooming and panning along the specified axis.

Parameters

Parameter	Type	Description	Required
scrollbar	WebChartAxisScrollBar	The scrollbar configuration to set.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.

Returns: void

Example

// Sets the scrollbar for the x-axis
chartModel.setAxisScrollbar(
  {
    visible: true,
    width: 20,
    color: [70, 174, 211, 255],
    gripSize: 32,
    margin: 8,
  },
  0,
);

// Sets the scrollbar for the y-axis
chartModel.setAxisScrollbar(
  {
    visible: true,
    width: 20,
    color: [158, 194, 49, 255],
    gripSize: 32,
    margin: 8,
  },
  1,
);

setAxisTitleSymbol

Method

Signature: setAxisTitleSymbol (titleSymbol: WebChartTextSymbol | undefined, axisIndex?: number): void

Sets the title text symbol for the specified axis. Contains styling information such as font, color, and symbol style.

Parameters

Parameter	Type	Description	Required
titleSymbol	WebChartTextSymbol \| undefined	The title text symbol to set.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis. If omitted, all axes will be updated.

Returns: void

setAxisTitleText

Method

Signature: setAxisTitleText (titleText: string, axisIndex: number): void

Sets the title text for the specified axis.

Parameters

Parameter	Type	Description	Required
titleText	string	The title text for the axis.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.

Returns: void

setAxisTitleVisibility

Method

Signature: setAxisTitleVisibility (isVisible: boolean, axisIndex?: number): void

Sets the visibility of the specified axis title.

Parameters

Parameter	Type	Description	Required
isVisible	boolean	The visibility state for the axis title.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis. If omitted, all axes will be updated.

Returns: void

setAxisValueFormat

Method

Signature: setAxisValueFormat (axisIndex: number, valueFormat?: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions): void

Sets the value format for the specified axis.

Parameters

Parameter	Type	Description	Required
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.
valueFormat	CategoryFormatOptions \| DateTimeFormatOptions \| NumberFormatOptions	The value format to set.

Returns: void

setAxisVisibility

Method

Signature: setAxisVisibility (isVisible: boolean, axisIndex: number): void

Sets the visibility of the specified axis.

Parameters

Parameter	Type	Description	Required
isVisible	boolean	The visibility state for the axis.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.

Returns: void

setBuffer

Method

Signature: setBuffer (buffer: boolean, axisIndex?: number): void

Sets the buffer for the specified axis.

This setting is only applicable to the axis of type ValueAxis

with `setBuffer`	without `setBuffer`

Parameters

Parameter	Type	Description	Required
buffer	boolean	The setting for the buffer.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis. If omitted, all compatible value axes will be updated.

Returns: void

setDataFilters

inherited Method

Signature: setDataFilters (newDataFilters: WebChartDataFilters | undefined): Promise<void>

Inherited from: WithDataFilters

Sets the data filter for the chart.

Parameters

Parameter	Type	Description	Required
newDataFilters	WebChartDataFilters \| undefined	The new data filter.

Returns: Promise<void>

setDataTooltipFontSize

inherited Method

Signature: setDataTooltipFontSize (fontSize: number | undefined, seriesIndex: number): void

Inherited from: WithSeriesDataTooltipFontSize

Sets the data tooltip font size for a series.

Parameters

Parameter	Type	Description	Required
fontSize	number \| undefined	The font size to set.
seriesIndex	number	The index of the series to set the font size for.

Returns: void

setDataTooltipValueFormat

inherited Method

Signature: setDataTooltipValueFormat (seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void

Inherited from: WithSeriesDataTooltipValueFormat

Sets the data tooltip value format for a series.

Parameters

Parameter	Type	Description	Required
seriesIndex	number	The index of the series to set the value format for.
valueFormat	NumberFormatOptions \| undefined	The value format to set.

Returns: void

setDisplayCursorTooltip

Method

Signature: setDisplayCursorTooltip (displayCursorTooltip: boolean, axisIndex?: number): void

Sets the display cursor tooltip setting for the specified axis.

Parameters

Parameter	Type	Description	Required
displayCursorTooltip	boolean	The display cursor tooltip setting for the axis.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis. If omitted, all axes will be updated.

Returns: void

setDisplayZeroLine

Method

Signature: setDisplayZeroLine (displayZeroLine: 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.

Parameters

Parameter	Type	Description	Required
displayZeroLine	boolean	The display zero line setting for the axis.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis. If omitted, all compatible value axes will be updated.

Returns: void

setGridLinesSymbol

Method

Signature: setGridLinesSymbol (linesSymbol: ISimpleLineSymbol | undefined, axisIndices?: number[]): void

Sets the grid lines symbol. Contains styling information such as line width, line style, and line color.

See also

Styling with charts model

Parameters

Parameter	Type	Description	Required
linesSymbol	ISimpleLineSymbol \| undefined	The grid lines symbol.
axisIndices	number[]	The indices of the axes to set the grid lines symbol for. If omitted, the symbol is applied to all axes.

Returns: void

Example

// 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

setHorizontalAxisLabelsBehavior

Method

Signature: setHorizontalAxisLabelsBehavior (horizontalBehavior: WebChartLabelBehavior): void

Sets the horizontal axis labels behavior for the chart.

Default behavior is rotate, except for histogram where the default is hide.

`hide`	`rotate`	`stagger`	`wrap`

Parameters

Parameter	Type	Description	Required
horizontalBehavior	WebChartLabelBehavior	The behavior for the horizontal axis labels.

Returns: void

setIntegerOnlyValues

Method

Signature: setIntegerOnlyValues (integerOnlyValues: boolean, axisIndex?: number): void

Sets the integer only values setting for the specified axis.

This setting is only applicable to the axis of type ValueAxis.

Parameters

Parameter	Type	Description	Required
integerOnlyValues	boolean	The boolean value to set for the integer only values setting.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis. If omitted, all compatible value axes will be updated.

Returns: void

setLogarithmic

Method

Signature: setLogarithmic (isLogarithmic: boolean, axisIndex: number): void

Sets whether logarithmic scale is enabled for the specified axis.

X-axis (`axisIndex: 0`)	Primary y-axis (`axisIndex: 1`)	Both axes

Parameters

Parameter	Type	Description	Required
isLogarithmic	boolean	Whether to enable logarithmic scale for the specified axis.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.

Returns: void

Example

// Apply a logarithmic scale to the x-axis (index 0) and primary y-axis (index 1)
chartModel.setLogarithmic(true, 0);
chartModel.setLogarithmic(true, 1);

setMaxBound

Method

Signature: setMaxBound (newMaxBound: number | null, axisIndex: number): void

Sets the maximum bound for the specified axis.

Parameters

Parameter	Type	Description	Required
newMaxBound	number \| null	The value to set as the maximum bound.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.

Returns: void

setMinBound

Method

Signature: setMinBound (newMinBound: number | null, axisIndex: number): void

Sets the minimum bound for the specified axis.

Parameters

Parameter	Type	Description	Required
newMinBound	number \| null	The value to set as the minimum bound.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.

Returns: void

setSeriesVisibility

inherited Method

Signature: setSeriesVisibility (props: LegendItemVisibility): void

Inherited from: WithSeriesVisibility

Sets the visibility of a series.

Parameters

Parameter	Type	Description	Required
props	LegendItemVisibility	Visibility options for the series.

Returns: void

setTickSpacing

Method

Signature: setTickSpacing (tickSpacing: number, axisIndex: number): void

Sets the tick spacing for the specified axis.

Parameters

Parameter	Type	Description	Required
tickSpacing	number	The value to set for the tick spacing.
axisIndex	number	Axis index for the chart: `0` for x-axis, `1` for primary y-axis, and `2` for secondary y-axis.

Returns: void

setup

inherited Method

Signature: setup (params: ModelParams<ChartConfig>): Promise<void>

Inherited from: ChartModelBase

Completes the async setup process for the chart model. Must be called before using the model.

Parameters

Parameter	Type	Description	Required
params	ModelParams<ChartConfig>	The parameters to be used to set up the chart model.

Returns: Promise<void>

setVerticalAxisLabelsBehavior

Method

Signature: setVerticalAxisLabelsBehavior (verticalBehavior: WebChartLabelBehavior): void

Sets the vertical axis labels behavior for the chart.

`hide`	`wrap`

Parameters

Parameter	Type	Description	Required
verticalBehavior	WebChartLabelBehavior	The behavior for the vertical axis labels.

Returns: void

update

inherited Method

Signature: update (): Promise<void>

Inherited from: ChartModelBase

Can be awaited to allow any pending async updates to complete.

Returns: Promise<void>