Skip to content
ESM
import { customSortString, SerialChartDataSortingKinds, BoxPlotDataSortingKinds, HeatChartDataSortingKinds, PieChartDataSortingKinds } from "@arcgis/charts-components/model/interfaces/common.js";

Variables

customSortString

Variable
Type
"customSort"

SerialChartDataSortingKinds

Variable
Type
{ readonly xAxisAsc: "xAxisAsc"; readonly xAxisDesc: "xAxisDesc"; readonly yAxisAsc: "yAxisAsc"; readonly yAxisDesc: "yAxisDesc"; readonly customSort: "customSort"; }

BoxPlotDataSortingKinds

Variable
Type
{ readonly xAxisAsc: "xAxisAsc"; readonly xAxisDesc: "xAxisDesc"; readonly meanAsc: "meanAsc"; readonly meanDesc: "meanDesc"; readonly medianAsc: "medianAsc"; readonly medianDesc: "medianDesc"; readonly customSort: "customSort"; }

HeatChartDataSortingKinds

Variable
Type
{ readonly Asc: "Asc"; readonly Desc: "Desc"; readonly customSort: "customSort"; }

PieChartDataSortingKinds

Variable
Type
{ readonly labelAsc: "labelAsc"; readonly labelDesc: "labelDesc"; readonly valueAsc: "valueAsc"; readonly valueDesc: "valueDesc"; readonly customSort: "customSort"; }

PieChartDataModes

Variable
Type
{ readonly Category: "category"; readonly Fields: "fields"; }

PieChartSlicesDisplay

Variable
Type
{ readonly Category: "category"; readonly Value: "value"; readonly Percentage: "percentage"; readonly Both: "both"; }

FormatKeys

Variable
Type
{ readonly TextElements: "textElements"; readonly XAxisTitle: "xAxisTitle"; readonly YAxisTitle: "yAxisTitle"; readonly AxisLabels: "axisLabels"; readonly GuideLabels: "guideLabels"; readonly Title: "title"; readonly LegendText: "legendText"; readonly LegendTitle: "legendTitle"; readonly Description: "description"; readonly DataLabels: "dataLabels"; readonly Background: "background"; readonly LeaderLines: "leaderLines"; readonly AxisLines: "axisLines"; readonly GridLines: "gridLines"; }

LineFormatKeys

Variable
Type
{ readonly AxisLines: "axisLines"; readonly GridLines: "gridLines"; readonly LeaderLines: "leaderLines"; }

TextFormatKeys

Variable
Type
{ readonly Title: "title"; readonly XAxisTitle: "xAxisTitle"; readonly YAxisTitle: "yAxisTitle"; readonly AxisLabels: "axisLabels"; readonly GuideLabels: "guideLabels"; readonly LegendText: "legendText"; readonly LegendTitle: "legendTitle"; readonly Description: "description"; readonly DataLabels: "dataLabels"; }

ColorFormatKeys

Variable
Type
{ readonly Background: "background"; }

GuideOrientation

Variable

Axis orientation of the guide.

Type
{ readonly X: "x"; readonly Y: "y"; }

ModelTypes

Variable
Type
{ readonly BarChart: "barChart"; readonly LineChart: "lineChart"; readonly ComboBarLineChart: "comboBarLineChart"; readonly BoxPlot: "boxPlot"; readonly PieChart: "pieChart"; readonly Scatterplot: "scatterplot"; readonly Histogram: "histogram"; readonly Gauge: "gauge"; readonly RadarChart: "radarChart"; readonly HeatChart: "heatChart"; }

Type definitions

SerialChartDataSortingKinds

Type definition

BoxPlotDataSortingKinds

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

HeatChartDataSortingKinds

Type definition

PieChartDataSortingKinds

Type definition

PieChartDataModes

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

PieChartSlicesDisplay

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

FormatKeys

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

LineFormatKeys

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

TextFormatKeys

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

ColorFormatKeys

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

GuideOrientation

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

SplitByFieldInfos

Type definition

categoriesArray

Property
Type
(number | string)[]

splitByFieldType

Property
Type
string | undefined

numericalField

Property
Type
string

PieSeriesDisplayOptions

Type definition

displayCategoryOnDataLabel

Property
Type
boolean

displayNumericValueOnDataLabel

Property
Type
boolean

displayPercentageOnDataLabel

Property
Type
boolean

displayNumericValue

Property
Type
boolean

displayPercentage

Property
Type
boolean

LayerInfo

Type definition

layer

Property
Type
SupportedLayer

Layer used for this bar chart.

layerFieldsInfo

Property
Type
IField[]

Fields information for the layer.

objectIdField

Property
Type
string

Object ID field name for the layer.

ModelTypes

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