import { WithDataFilters } from "@arcgis/charts-components/model/properties/data-filters.js";- Inheritance:
- WithDataFilters→
chart-model-base→ EventTarget
- Subclasses:
- chart-model
Adds support for working with chart data filters.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| args | any[] | | |
Properties
| Property | Type | Class |
|---|---|---|
asyncUpdatesPromise inherited | ||
chartType readonly inherited | ||
dataStore 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.
dataStore
- Type
- any
Data store object that can be used to store any data needed for the chart.
Methods
| Method | Signature | Class |
|---|---|---|
generateChartTitle inherited | generateChartTitle(): string | |
getDataFilters(): WebChartDataFilters | undefined | | |
isSameChartAs inherited | isSameChartAs(otherModel: ChartModel | undefined): boolean | |
setDataFilters(newDataFilters: WebChartDataFilters | undefined): Promise<void> | | |
setup inherited | setup(params: ModelParams<ChartConfig>): Promise<void> | |
update 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 bar chart.
- Returns
- WebChartDataFilters | undefined
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
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.