import { PieChartLegendModel } from "@arcgis/charts-components/model/pie-chart-model/pie-chart-legend-model.js";- Inheritance:
- PieChartLegendModel→
model-with-legend→ chart-model→ chart-model-base→ EventTarget
- Subclasses:
- pie-chart-model
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| args | any[] | | |
Properties
| Property | Type | Class |
|---|---|---|
asyncUpdatesPromise inherited | ||
backgroundColor inherited | ||
chartId inherited | ||
chartRenderer inherited | IDrawingInfo["renderer"] | undefined | |
chartSubtitleVisibility inherited | ||
chartSubType readonly inherited | ||
chartTitleVisibility inherited | ||
chartType readonly inherited | ||
config inherited | ||
dataStore inherited | ||
descriptionSymbol inherited | ||
descriptionText inherited | ||
descriptionVisibility inherited | ||
| | ||
fetchNULLValues inherited | ||
layer readonly inherited | ||
legendMaxHeight inherited | ||
legendPosition inherited | ||
legendRoundMarker inherited | ||
legendTextSymbol inherited | ||
legendTitleSymbol inherited | ||
legendTitleText inherited | ||
legendTitleVisibility inherited | ||
legendVisibility inherited | ||
seriesLength readonly inherited | ||
splitByValues readonly inherited | string[] | |
subtitleSymbol inherited | ||
subtitleText inherited | ||
titleSymbol inherited | ||
titleText inherited | ||
| | ||
version 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 | undefined
The chart model's layer.
legendPosition
Legend position: top, bottom, left, or right.
legendRoundMarker
- Type
- boolean
Whether legend markers are rounded.
legendTextSymbol
- Type
- WebChartTextSymbol | undefined
Legend item text symbol (font, color, style).
legendTitleSymbol
- Type
- WebChartTextSymbol | undefined
Legend title text symbol (font, color, style).
legendTitleText
- Type
- string
The legend title text.
legendTitleVisibility
- Type
- boolean
Whether the legend title is visible.
legendVisibility
- Type
- boolean
Whether the legend title is visible.
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 |
|---|---|---|
generateChartTitle inherited | generateChartTitle(): string | |
getDataFilters inherited | getDataFilters(): WebChartDataFilters | undefined | |
getDataTooltipValueFormat inherited | getDataTooltipValueFormat(seriesIndex: number): NumberFormatOptions | undefined | |
getDisplayNumericValue(): boolean | | |
getDisplayPercentage(): boolean | | |
getLabelMaxWidth(): number | | |
getSeriesId inherited | getSeriesId(seriesIndex: number): string | undefined | |
getSeriesIndex inherited | getSeriesIndex(seriesId: string): number | undefined | |
getSeriesVisibility inherited | getSeriesVisibility(seriesIndex: number): boolean | |
isSameChartAs inherited | isSameChartAs(otherModel: ChartModel | undefined): boolean | |
setDataFilters inherited | setDataFilters(newDataFilters: WebChartDataFilters | undefined): Promise<void> | |
setDataTooltipValueFormat inherited | setDataTooltipValueFormat(seriesIndex: number, valueFormat: NumberFormatOptions | undefined): void | |
setDisplayNumericValue(displayNumericValue: boolean): void | | |
setDisplayPercentage(displayPercentage: boolean): void | | |
setLabelMaxWidth(labelMaxWidth: number | undefined): void | | |
setSeriesVisibility inherited | setSeriesVisibility(props: LegendItemVisibility): 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
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
getDisplayNumericValue
- Signature
-
getDisplayNumericValue (): boolean
Gets the setting for the display of numerical value in the legend items.
Note: Only applicable to pie charts.
- Returns
- boolean
getDisplayPercentage
- Signature
-
getDisplayPercentage (): boolean
Gets the setting for the display of percentage in the legend items.
Note: Only applicable to pie charts.
- Returns
- boolean
getLabelMaxWidth
- Signature
-
getLabelMaxWidth (): number
Gets the maximum width in pixel for the legend item labels.
Note: Only applicable to pie charts.
- Returns
- number
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
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. | |
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.