Skip to content
ESM
import { ChartComponentEvents, ActionToggle, ActionState, ErrorPolicy, ChangePolicy } from "@arcgis/charts-components/utils/types/index.js";

Type definitions

ActionBarHideActionsProps

Type definition

Interface to hold the action bar properties.

hideClearSelection

Property
Type
boolean | undefined

Determines whether to hide clear selection action or not.

hideFilterByExtent

Property
Type
boolean | undefined

Determines whether to hide filter by extent action or not.

hideFilterBySelection

Property
Type
boolean | undefined

Determines whether to hide filter by selection action or not.

hideFullExtent

Property
Type
boolean | undefined

Determines whether to hide full extent action or not.

hideLegend

Property
Type
boolean | undefined

Determines whether to hide legend action or not.

hideRotateChart

Property
Type
boolean | undefined

Determines whether to hide rotate action or not.

hideSelection

Property
Type
boolean | undefined

Determines whether to hide selection action or not.

hideSwitchSelection

Property
Type
boolean | undefined

Determines whether to hide switch selection action or not.

hideZoom

Property
Type
boolean | undefined

Determines whether to hide zoom action or not.

hideExpandAction

Property
Type
boolean | undefined

Determines whether to hide expand action or not.

DefaultChartActions

Type definition
Type
(typeof DefaultChartActions)[keyof typeof DefaultChartActions]

ChartConfig

Type definition
Type parameters
<T extends ModelTypes = ModelTypes, V extends WebChart = T extends typeof ModelTypes.BoxPlot ? WebBoxPlot : T extends typeof ModelTypes.Gauge ? WebGaugeChart : T extends typeof ModelTypes.HeatChart ? WebHeatChart : WebChart>

Type alias for a chart configuration.

This type is generic and supports configuration for different chart types, data source types, and data source requirement policies.

It extends and modifies the base WebChart while replacing the generic series with the specific series type.

Supertypes
Omit<V‚ "legend" | "series">

series

Property
Type
ModelTypeToSeriesType[]

legend

Property
Type
T extends typeof ModelTypes.PieChart ? WebChartPieChartLegend : WebChartLegend | undefined

ActionToggle

Type definition
Type
(typeof ActionToggle)[keyof typeof ActionToggle]

ActionState

Type definition
Type
(typeof ActionState)[keyof typeof ActionState]

ErrorPolicy

Type definition
Type
(typeof ErrorPolicy)[keyof typeof ErrorPolicy]

ChangePolicy

Type definition
Type
(typeof ChangePolicy)[keyof typeof ChangePolicy]

LayerFilterChangePolicy

Type definition
Supertypes
ChangePolicy

LayerRendererChangePolicy

Type definition
Supertypes
ChangePolicy

LayerFieldsChangePolicy

Type definition
Supertypes
ChangePolicy

ViewTimeExtentChangePolicy

Type definition
Supertypes
ChangePolicy

SyncSelectionsBetweenChartAndLayerViewPolicy

Type definition

Variables

ChartComponentEvents

Variable
Type
{ readonly DataProcessComplete: "arcgisDataProcessComplete"; readonly DataFetchComplete: "arcgisDataFetchComplete"; readonly DataProcessError: "arcgisDataProcessError"; readonly LegendItemVisibilityChange: "arcgisLegendItemVisibilityChange"; readonly UpdateComplete: "arcgisUpdateComplete"; readonly SeriesColorChange: "arcgisSeriesColorChange"; readonly AxesMinMaxChange: "arcgisAxesMinMaxChange"; readonly DefaultActionSelect: "arcgisDefaultActionSelect"; readonly SelectionComplete: "arcgisSelectionComplete"; readonly ActionBarToggle: "arcgisActionBarToggle"; readonly NoRenderPropChange: "arcgisNoRenderPropChange"; readonly BadDataWarningRaise: "arcgisBadDataWarningRaise"; readonly InvalidConfigRaise: "arcgisInvalidConfigWarningRaise"; readonly SeriesOrder: "arcgisSeriesOrder"; readonly RuntimeError: "arcgisRuntimeError"; readonly ConfigChange: "arcgisConfigChange"; readonly RenderingComplete: "arcgisRenderingComplete"; }

ActionToggle

Variable
Type
{ readonly Active: "active"; readonly Inactive: "inactive"; }

ActionState

Variable
Type
{ readonly Enabled: "enabled"; readonly Disabled: "disabled"; }

ErrorPolicy

Variable
Type
{ readonly Ignore: "ignore"; readonly Throw: "throw"; }

ChangePolicy

Variable
Type
{ readonly Ignore: "ignore"; readonly Refresh: "refresh"; }

LayerFilterChangePolicy

Variable
Type
{ readonly Ignore: "ignore"; readonly Refresh: "refresh"; }

LayerRendererChangePolicy

Variable
Type
{ readonly Ignore: "ignore"; readonly Refresh: "refresh"; }

LayerFieldsChangePolicy

Variable
Type
{ readonly Ignore: "ignore"; readonly Refresh: "refresh"; }

ViewTimeExtentChangePolicy

Variable
Type
{ readonly Ignore: "ignore"; readonly Refresh: "refresh"; }

SyncSelectionsBetweenChartAndLayerViewPolicy

Variable
Type
{ readonly Enabled: "enabled"; readonly Disabled: "disabled"; }