ESM

import { ModelWithYGuides } from "@arcgis/charts-components/model/mixins/model-with-y-guides.js";

Inheritance:: ModelWithYGuides→model-with-guides→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
`dataStore` inherited	`any`	ChartModelBase
`descriptionSymbol` inherited	`WebChartTextSymbol \| undefined`	WithDescriptionSymbol
`descriptionText` inherited	`string`	WithDescriptionText
`descriptionVisibility` inherited	`boolean`	WithDescriptionVisibility
`fetchNULLValues` inherited	`boolean`	WithFetchNULLValues
`guideLabelsSymbol` inherited	`WebChartTextSymbol \| undefined`	ModelWithGuides
`layer` readonly inherited	`SupportedLayer \| undefined`	WithLayer
`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.

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.

guideLabelsSymbol

inherited Property

Type: WebChartTextSymbol | undefined

Inherited from: ModelWithGuides

The guide labels text symbol (font, color, style).

layer

readonlyinherited Property

Type: SupportedLayer | undefined

Inherited from: WithLayer

The chart model's layer.

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
`addYAxisGuide`	`addYAxisGuide(name: string, index?: number): void`
`deleteYAxisGuide`	`deleteYAxisGuide(index?: number): void`
`generateChartTitle` inherited	`generateChartTitle(): string`	ChartModelBase
`getDataFilters` inherited	`getDataFilters(): WebChartDataFilters \| undefined`	WithDataFilters
`getDataTooltipValueFormat` inherited	`getDataTooltipValueFormat(seriesIndex: number): NumberFormatOptions \| undefined`	WithSeriesDataTooltipValueFormat
`getGuideAbove` inherited	`getGuideAbove(index?: number, orientation?: GuideOrientation): boolean`	ModelWithGuides
`getGuideEnd` inherited	`getGuideEnd(index?: number, orientation?: GuideOrientation): Date \| number \| string \| null \| undefined`	ModelWithGuides
`getGuideLabelText` inherited	`getGuideLabelText(index?: number, orientation?: GuideOrientation): string \| undefined`	ModelWithGuides
`getGuideName` inherited	`getGuideName(index?: number, orientation?: GuideOrientation): string \| undefined`	ModelWithGuides
`getGuideStart` inherited	`getGuideStart(index?: number, orientation?: GuideOrientation): Date \| number \| string \| null`	ModelWithGuides
`getGuideStyle` inherited	`getGuideStyle(index?: number, orientation?: GuideOrientation): ISimpleFillSymbol \| ISimpleLineSymbol \| undefined`	ModelWithGuides
`getGuideVisibility` inherited	`getGuideVisibility(index?: number, orientation?: GuideOrientation): boolean`	ModelWithGuides
`getSeriesId` inherited	`getSeriesId(seriesIndex: number): string \| undefined`	WithSeriesId
`getSeriesIndex` inherited	`getSeriesIndex(seriesId: string): number \| undefined`	WithSeriesIndex
`getSeriesVisibility` inherited	`getSeriesVisibility(seriesIndex: number): boolean`	WithSeriesVisibility
`getTooltipReverseColor` inherited	`getTooltipReverseColor(index: number, orientation?: GuideOrientation): boolean`	ModelWithGuides
`getYGuidesLength`	`getYGuidesLength(): number \| undefined`
`isSameChartAs` inherited	`isSameChartAs(otherModel: ChartModel \| undefined): boolean`	ChartModelBase
`setDataFilters` inherited	`setDataFilters(newDataFilters: WebChartDataFilters \| undefined): Promise<void>`	WithDataFilters
`setDataTooltipValueFormat` inherited	`setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions \| undefined): void`	WithSeriesDataTooltipValueFormat
`setGuideAbove` inherited	`setGuideAbove(above: boolean, index?: number, orientation?: GuideOrientation): void`	ModelWithGuides
`setGuideEnd` inherited	`setGuideEnd(end: Date \| number \| string \| null \| undefined, index?: number, orientation?: GuideOrientation): void`	ModelWithGuides
`setGuideLabelText` inherited	`setGuideLabelText(labelText: string, index?: number, orientation?: GuideOrientation): void`	ModelWithGuides
`setGuideName` inherited	`setGuideName(name: string, index?: number, orientation?: GuideOrientation): void`	ModelWithGuides
`setGuideStart` inherited	`setGuideStart(start: Date \| number \| string \| null, index?: number, orientation?: GuideOrientation): void`	ModelWithGuides
`setGuideStyle` inherited	`setGuideStyle(style: ISimpleFillSymbol \| ISimpleLineSymbol, index?: number, orientation?: GuideOrientation): void`	ModelWithGuides
`setGuideVisibility` inherited	`setGuideVisibility(visible: boolean, index?: number, orientation?: GuideOrientation): void`	ModelWithGuides
`setSeriesVisibility` inherited	`setSeriesVisibility(props: LegendItemVisibility): void`	WithSeriesVisibility
`setTooltipReverseColor` inherited	`setTooltipReverseColor(reverseColor: boolean, index: number, orientation?: GuideOrientation): void`	ModelWithGuides
`setup` inherited	`setup(params: ModelParams<ChartConfig>): Promise<void>`	ChartModelBase
`update` inherited	`update(): Promise<void>`	ChartModelBase

addYAxisGuide

Method

Signature: addYAxisGuide (name: string, index?: number): void

Adds a Y-axis guide.

Parameters

Parameter	Type	Description	Required
name	`string`	The name of the guide.
index	`number`	The index to insert the new guide in the list of Y-axis guides. If left `undefined`, the guide is appended to the end of the list.

Returns: void

deleteYAxisGuide

Method

Signature: deleteYAxisGuide (index?: number): void

Deletes a Y-axis guide.

Parameters

Parameter	Type	Description	Required
index	`number`	The index of the guide to delete in the list of Y-axis guides. If left `undefined`, the last guide in the list is deleted.

Returns: void

generateChartTitle

inherited Method

Signature: generateChartTitle (): string

Inherited from: ChartModelBase

Generate the proper chart title from the current config.

Returns: string

getDataFilters

inherited Method

Signature: getDataFilters (): WebChartDataFilters | undefined

Inherited from: WithDataFilters

Gets the data filter for the bar chart.

Returns: WebChartDataFilters | undefined

getDataTooltipValueFormat

inherited Method

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

Inherited from: WithSeriesDataTooltipValueFormat

Gets the data tooltip value format 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 value format for.

Returns: NumberFormatOptions | undefined

getGuideAbove

inherited Method

Signature: getGuideAbove (index?: number, orientation?: GuideOrientation): boolean

Inherited from: ModelWithGuides

Gets whether the guide should be rendered above the other chart elements.

Parameters

Parameter	Type	Description	Required
index	`number`	Default `0`. The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	Default `y`. The axis orientation of the guide.

Returns: boolean

getGuideEnd

inherited Method

Signature: getGuideEnd (index?: number, orientation?: GuideOrientation): Date | number | string | null | undefined

Inherited from: ModelWithGuides

Gets the end value of a guide.

Parameters

Returns: Date | number | string | null | undefined

getGuideLabelText

inherited Method

Signature: getGuideLabelText (index?: number, orientation?: GuideOrientation): string | undefined

Inherited from: ModelWithGuides

Gets the guide label text.

Parameters

Returns: string | undefined

getGuideName

inherited Method

Signature: getGuideName (index?: number, orientation?: GuideOrientation): string | undefined

Inherited from: ModelWithGuides

Gets the name of a guide.

Parameters

Returns: string | undefined

getGuideStart

inherited Method

Signature: getGuideStart (index?: number, orientation?: GuideOrientation): Date | number | string | null

Inherited from: ModelWithGuides

Gets the start value of a guide.

Parameters

Returns: Date | number | string | null

getGuideStyle

inherited Method

Signature: getGuideStyle (index?: number, orientation?: GuideOrientation): ISimpleFillSymbol | ISimpleLineSymbol | undefined

Inherited from: ModelWithGuides

Gets the guide style.

Parameters

Returns: ISimpleFillSymbol | ISimpleLineSymbol | undefined

getGuideVisibility

inherited Method

Signature: getGuideVisibility (index?: number, orientation?: GuideOrientation): boolean

Inherited from: ModelWithGuides

Gets whether a guide is visible.

Parameters

Returns: boolean

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

getTooltipReverseColor

inherited Method

Signature: getTooltipReverseColor (index: number, orientation?: GuideOrientation): boolean

Inherited from: ModelWithGuides

Gets whether the tooltip text color should be reversed for a guide.

Parameters

Parameter	Type	Description	Required
index	`number`	The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	The axis orientation of the guide.

Returns: boolean

getYGuidesLength

Method

Signature: getYGuidesLength (): number | undefined

Gets the number guides in the Y-axis guides list.

Returns: number | undefined
The number of Y-axis guides.

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

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>

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

setGuideAbove

inherited Method

Signature: setGuideAbove (above: boolean, index?: number, orientation?: GuideOrientation): void

Inherited from: ModelWithGuides

Sets whether the guide should be rendered above the other chart elements.

Parameters

Parameter	Type	Description
above	`boolean`	New above boolean to set.
index	`number`	Default `0`. The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	Default `y`. The axis orientation of the guide.

Returns: void

setGuideEnd

inherited Method

Signature: setGuideEnd (end: Date | number | string | null | undefined, index?: number, orientation?: GuideOrientation): void

Inherited from: ModelWithGuides

Sets the end value of a guide.

Parameters

Parameter	Type	Description
end	`Date \| number \| string \| null \| undefined`	New end value to set.
index	`number`	Default `0`. The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	Default `y`. The axis orientation of the guide.

Returns: void

setGuideLabelText

inherited Method

Signature: setGuideLabelText (labelText: string, index?: number, orientation?: GuideOrientation): void

Inherited from: ModelWithGuides

Sets the guide label text.

Parameters

Parameter	Type	Description
labelText	`string`	New label text to set.
index	`number`	Default `0`. The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	Default `y`. The axis orientation of the guide.

Returns: void

setGuideName

inherited Method

Signature: setGuideName (name: string, index?: number, orientation?: GuideOrientation): void

Inherited from: ModelWithGuides

Sets the name of a guide.

Parameters

Parameter	Type	Description
name	`string`	New name to set.
index	`number`	Default `0`. The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	Default `y`. The axis orientation of the guide.

Returns: void

setGuideStart

inherited Method

Signature: setGuideStart (start: Date | number | string | null, index?: number, orientation?: GuideOrientation): void

Inherited from: ModelWithGuides

Sets the start value of a guide.

Parameters

Parameter	Type	Description
start	`Date \| number \| string \| null`	New start value to set.
index	`number`	Default `0`. The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	Default `y`. The axis orientation of the guide.

Returns: void

setGuideStyle

inherited Method

Signature: setGuideStyle (style: ISimpleFillSymbol | ISimpleLineSymbol, index?: number, orientation?: GuideOrientation): void

Inherited from: ModelWithGuides

Sets the guide style.

Parameters

Parameter	Type	Description
style	`ISimpleFillSymbol \| ISimpleLineSymbol`	New style to set.
index	`number`	Default `0`. The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	Default `y`. The axis orientation of the guide.

Returns: void

Example

chartModel.setGuideStyle(
 {
    type: "esriSLS",
    color: [0, 200, 0, 255],
    width: 2,
  },
  1,
);

setGuideVisibility

inherited Method

Signature: setGuideVisibility (visible: boolean, index?: number, orientation?: GuideOrientation): void

Inherited from: ModelWithGuides

Sets whether a guide is visible.

Parameters

Parameter	Type	Description
visible	`boolean`	New visibility to set.
index	`number`	Default `0`. The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	Default `y`. The axis orientation of the guide.

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

setTooltipReverseColor

inherited Method

Signature: setTooltipReverseColor (reverseColor: boolean, index: number, orientation?: GuideOrientation): void

Inherited from: ModelWithGuides

Sets whether the tooltip text color should be reversed for a guide.

Parameters

Parameter	Type	Description
reverseColor	`boolean`	New reverseColor boolean to set.
index	`number`	The index of the guide in the list of guides for the given axis orientation.
orientation	`GuideOrientation`	The axis orientation of the guide.

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>

update

inherited Method

Signature: update (): Promise<void>

Inherited from: ChartModelBase

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

Returns: Promise<void>