Skip to content
ESM
import { ChartSubType, SelectionSource } from "@arcgis/charts-components/utils/misc/interfaces.js";

Variables

ChartSubType

Variable
Type
{ readonly NonSpecific: "nonSpecific"; readonly BarAndLineNoAggregation: "barAndLineNoAggregation"; readonly BarAndLineMonoField: "barAndLineMonoField"; readonly BarAndLineMultiFields: "barAndLineMultiFields"; readonly BarAndLineFromFields: "barAndLineFromFields"; readonly BarAndLineSplitBy: "barAndLineSplitBy"; readonly BarAndLineSplitByNoAggregation: "barAndLineSplitByNoAggregation"; readonly PieNoAggregation: "pieNoAggregation"; readonly PieFromCategory: "pieFromCategory"; readonly PieFromFields: "pieFromFields"; readonly BoxPlotMonoField: "boxPlotMonoField"; readonly BoxPlotMultiFields: "boxPlotMultiFields"; readonly BoxPlotMonoFieldAndCategory: "boxPlotMonoFieldAndCategory"; readonly BoxPlotMultiFieldsAndCategory: "boxPlotMultiFieldsAndCategory"; readonly BoxPlotMonoFieldAndSplitBy: "boxPlotMonoFieldAndSplitBy"; readonly BoxPlotMultiFieldsAndSplitBy: "boxPlotMultiFieldsAndSplitBy"; readonly BoxPlotMonoFieldAndCategoryAndSplitBy: "boxPlotMonoFieldAndCategoryAndSplitBy"; }

SelectionSource

Variable
Type
{ readonly SelectionByClick: "SelectionByClick"; readonly SelectionByRange: "SelectionByRange"; readonly ProgrammaticSelection: "ProgrammaticSelection"; readonly ClearSelection: "ClearSelection"; }

Type definitions

ChartSubType

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

SelectionSource

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

SelectionIndexes

Type definition
Supertypes
Map<number‚ { indexesToSelect?: number[]; }>

SelectionData

Type definition

selectionItems

Property
Type
WebChartDataItem[] | undefined

selectionIndexes

Property
Type
SelectionIndexes | undefined

selectionOIDs

Property
Type
(number | string)[] | undefined

selectionSource

Property
Type
SelectionSource | undefined

SelectionThemeProperties

Type definition

elementColor

Property
Type
Color | undefined

elementOutlineColor

Property
Type
Color | undefined

elementOutlineWidth

Property
Type
number | undefined

rotation

Property
Type
number | undefined

transformation

Property
Type
{ opacity?: number; scale?: number; } | undefined

SelectionTheme

Type definition

selectedElementsTheme

Property
Type
SelectionThemeProperties | undefined

nonSelectedElementsTheme

Property
Type
SelectionThemeProperties | undefined

LoaderColors

Type definition

curtainColor

Property
Type
Color | undefined

spinnerColor

Property
Type
Color | undefined

HeatSeriesColorChangePayload

Type definition

heatRulesType

Property
Type
WebChartHeatChartHeatRulesTypes | undefined

HeatSeriesColorChangePayloadGradient

Type definition

startColor

Property
Type
readonly [number, number, number, number]

endColor

Property
Type
readonly [number, number, number, number]

HeatSeriesColorChangePayloadClassSymbols

Type definition

label

Property
Type
string

symbol

Property
Type
ISimpleFillSymbol

BoxPlotSymbols

Type definition
Type
{ fillSymbol?: ISimpleFillSymbol; } | { lineSymbol: ISimpleLineSymbol; markerSymbol?: ISimpleMarkerSymbol; }

LineChartSymbols

Type definition

lineSymbol

Property
Type
ISimpleLineSymbol

markerSymbol

Property
Type
ISimpleMarkerSymbol | undefined

PieSlicesSymbols

Type definition

Type used to provide information regarding a pie chart's slices:

  • slices contains an array of WebChartPieChartSlice related to the non-grouped slices.
  • groupedSlices contains an array of WebChartPieChartSlice related to the non-visible grouped slices.
  • groupOfSlices contains a WebChartPieChartSlicerelated to the group of slices.

The WebChartPieChartSlice contains information regarding a slice's id, symbol and label.

slices

Property
Type
WebChartPieChartSlice[]

groupedSlices

Property
Type
WebChartPieChartSlice[] | undefined

groupOfSlices

Property
Type
WebChartPieChartGroupSlice | undefined

SeriesSymbolsMap

Type definition

Map containing a chart's series symbols. The numeric key is the series' position in the series array. The value is either:

  • A fill symbol (bar chart and histogram).
  • A marker symbol (scatterplot).
  • An object containing a line symbol and a marker symbol (line chart).
Supertypes
Map<number‚ SeriesSymbols | undefined>