▾
import { ModelWithTemporalBinning } from "@arcgis/charts-components/model/mixins/model-with-temporal-binning.js";- Inheritance
- ModelWithTemporalBinning→
chart-model→ chart-model-base→ EventTarget
- Subclasses
- serial-chart-model
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| args | any[] | | |
Properties
| Property | Type | Class |
|---|---|---|
| inherited | ||
| inherited | ||
| inherited | ||
| inherited | IDrawingInfo["renderer"] | undefined | |
| inherited | ||
| readonly inherited | ||
| inherited | ||
| readonly inherited | ||
| inherited | ||
| inherited | ||
| inherited | ||
| inherited | ||
| inherited | ||
| inherited | ||
| readonly inherited | ||
| | ||
| readonly inherited | ||
| readonly inherited | ||
| readonly inherited | string[] | |
| inherited | ||
| inherited | ||
| | ||
| | ||
| | ||
| inherited | ||
| inherited | ||
| | ||
| readonly inherited |
asyncUpdatesPromise
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
The background color of the chart.
chartRenderer
- Type
- IDrawingInfo["renderer"] | undefined
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
- Type
- boolean
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
- Type
- ChartSubType
The chart sub type of the series.
chartTitleVisibility
- Type
- boolean
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.
config
- Type
- ChartConfig
The current chart configuration object.
dataStore
- Type
- any
Data store object that can be used to store any data needed for the chart.
descriptionSymbol
- Type
- WebChartTextSymbol | undefined
The description text symbol. Contains styling information such as font, color, and symbol style.
descriptionVisibility
- Type
- boolean
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
- Type
- boolean
Whether to fetch null values for them to be counted or displayed as categories on the chart.
layer
- Type
- SupportedLayer | SupportedRasterLayer | undefined
The chart model's layer.
nullPolicy
- Type
- WebChartNullPolicyTypes | undefined
Policy which tells the chart how to handle null values.
null: Break the bar where null values are present.
zero: Treats null values as zero.
interpolate:
- Bar series: same effect as
null - Line series: connects the lines across null values.
revision
- Type
- number
The current revision number of the chart configuration. Increments with each update.
seriesLength
- Type
- number
The length of the series array.
splitByValues
- Type
- string[]
The split-by values for the chart.
subtitleSymbol
- Type
- WebChartTextSymbol | undefined
The subtitle text symbol. Contains styling information such as font, color, and symbol style.
subtitleText
- Type
- string
The chart subtitle text.
titleSymbol
- Type
- WebChartTextSymbol | undefined
The title text symbol. Contains styling information such as font, color, and symbol style.
version
The version of the chart configuration.
Methods
| Method | Signature | Class |
|---|---|---|
| inherited | generateChartTitle(): string | |
| inherited | getDataFilters(): WebChartDataFilters | undefined | |
| inherited | getDataTooltipFontSize(seriesIndex: number): number | undefined | |
| inherited | getDataTooltipValueFormat(seriesIndex: number): NumberFormatOptions | undefined | |
| inherited | getSeriesId(seriesIndex: number): string | undefined | |
| inherited | getSeriesIndex(seriesId: string): number | undefined | |
| inherited | getSeriesVisibility(seriesIndex: number): boolean | |
| inherited | isSameChartAs(otherModel: ChartModel | undefined): boolean | |
| inherited | recall(configRevision?: number): ChartConfig | undefined | |
| resetTimeInterval(): void | | |
| inherited | setDataFilters(newDataFilters: WebChartDataFilters | undefined): Promise<void> | |
| inherited | setDataTooltipFontSize(fontSize: number | undefined, seriesIndex: number): void | |
| inherited | setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void | |
| inherited | setSeriesVisibility(props: LegendItemVisibility): void | |
| inherited | setup(params: ModelParams<ChartConfig>): Promise<void> | |
| inherited | update(): Promise<void> |
generateChartTitle
- Signature
-
generateChartTitle (): string
Generate the proper chart title from the current config.
- Returns
- string
getDataFilters
- Signature
-
getDataFilters (): WebChartDataFilters | undefined
Gets the data filter for the chart.
- Returns
- WebChartDataFilters | undefined
getDataTooltipFontSize
- Signature
-
getDataTooltipFontSize (seriesIndex: number): number | undefined
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.
getDataTooltipValueFormat
- Signature
-
getDataTooltipValueFormat (seriesIndex: number): NumberFormatOptions | undefined
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 | The index of the series to retrieve the value format for. | |
- Returns
- NumberFormatOptions | undefined
getSeriesId
- Signature
-
getSeriesId (seriesIndex: number): string | undefined
Gets the series ID for a given series index.
If the series index is out of bounds, this function will return undefined.
getSeriesIndex
- Signature
-
getSeriesIndex (seriesId: string): number | undefined
Gets the series index for a given series ID.
If the series ID is not found, this function will return undefined.
getSeriesVisibility
- Signature
-
getSeriesVisibility (seriesIndex: number): boolean
Gets the visibility of a series.
isSameChartAs
- Signature
-
isSameChartAs (otherModel: ChartModel | undefined): boolean
Checks if the current chart model is for the same chart as another chart model.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| otherModel | The other chart model to compare to. | |
- Returns
- boolean
recall
- Signature
-
recall (configRevision?: number): ChartConfig | undefined
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 | | |
- Returns
- ChartConfig | undefined
resetTimeInterval
- Signature
-
resetTimeInterval (): void
Resets the time interval to default for a temporal line chart.
- Returns
- void
setDataFilters
- Signature
-
setDataFilters (newDataFilters: WebChartDataFilters | undefined): Promise<void>
Sets the data filter for the chart.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| newDataFilters | The new data filter. | |
setDataTooltipFontSize
- Signature
-
setDataTooltipFontSize (fontSize: number | undefined, seriesIndex: number): void
Sets the data tooltip font size for a series.
setDataTooltipValueFormat
- Signature
-
setDataTooltipValueFormat (seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void
Sets the data tooltip value format for a series.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| seriesIndex | The index of the series to set the value format for. | | |
| valueFormat | The value format to set. | |
- Returns
- void
setSeriesVisibility
- Signature
-
setSeriesVisibility (props: LegendItemVisibility): void
Sets the visibility of a series.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| props | Visibility options for the series. | |
- Returns
- void
setup
- Signature
-
setup (params: ModelParams<ChartConfig>): Promise<void>
Completes the async setup process for the chart model. Must be called before using the model.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| params | The parameters to be used to set up the chart model. | |
update
- Signature
-
update (): Promise<void>
Can be awaited to allow any pending async updates to complete.