import { WithNegativeValuesStackedToBaseline } from "@arcgis/charts-components/model/properties/series/negative-values-stacked-to-baseline.js";- Inheritance
- WithNegativeValuesStackedToBaseline→
chart-model-base→ EventTarget
Adds support for configuring whether negative values stack against the baseline.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| args | any[] | | |
Properties
| Property | Type | Class |
|---|---|---|
| inherited | ||
| readonly inherited | ||
| 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 |
|---|---|---|
| inherited | generateChartTitle(): string | |
| isNegativeValuesStackedToBaseline(seriesIndex: number): boolean | | |
| inherited | isSameChartAs(otherModel: ChartModel | undefined): boolean | |
| setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): 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
isNegativeValuesStackedToBaseline
- Signature
-
isNegativeValuesStackedToBaseline (seriesIndex: number): boolean
Specify how negative values are treated in stacked series.
Note: If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
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
setNegativeValuesStackedToBaseline
- Signature
-
setNegativeValuesStackedToBaseline (stackNegativeValuesToBaseline: boolean, seriesIndex: number): void
Specify how negative values are treated in stacked series.
Note: If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
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.