import { WebChartTypes, WebChartStatisticType, WebChartDataTransformations, WebChartColoringPatterns, WebChartLegendPositions } from "@arcgis/charts-components/spec/chart-object-literals.js";Variables
WebChartTypes
- Type
- { readonly Chart: "chart"; readonly Text: "chartText"; readonly Overlay: "chartOverlay"; readonly Overlays: "chartOverlays"; readonly Legend: "chartLegend"; readonly CursorCrosshair: "cursorCrosshair"; readonly Axis: "chartAxis"; readonly GaugeAxisTick: "gaugeAxisTick"; readonly GaugeNeedle: "gaugeNeedle"; readonly CategoryAxisFormat: "category"; readonly NumberAxisFormat: "number"; readonly DateAxisFormat: "date"; readonly Guide: "chartGuide"; readonly ScatterSeries: "scatterSeries"; readonly PieSeries: "pieSeries"; readonly PieTick: "pieTick"; readonly GaugeSeries: "gaugeSeries"; readonly LineSeries: "lineSeries"; readonly BarSeries: "barSeries"; readonly HistogramSeries: "histogramSeries"; readonly BoxPlotSeries: "boxPlotSeries"; readonly RadarSeries: "radarSeries"; readonly ComboLineAndBarSeries: "comboLineAndBarSeries"; readonly HeatSeries: "heatSeries"; readonly Buffer: "buffer"; readonly SizePolicy: "sizeScale"; readonly CalendarDateParts: "calendarDateParts"; }
WebChartStatisticType
- Type
- { readonly Count: "count"; readonly Sum: "sum"; readonly Minimum: "min"; readonly Maximum: "max"; readonly Average: "avg"; readonly StandardDeviation: "stddev"; readonly Variance: "var"; readonly ContinuousPercentile: "percentile-continuous"; readonly DiscretePercentile: "percentile-discrete"; readonly EnvelopeAggregate: "envelope-aggregate"; readonly CentroidAggregate: "centroid-aggregate"; readonly ConvexHullAggregate: "convex-hull-aggregate"; readonly NoAggregation: "no_aggregation"; }
WebChartDataTransformations
- Type
- { readonly None: "none"; readonly Log: "logarithmic"; readonly Sqrt: "squareRoot"; }
WebChartColoringPatterns
- Type
- { readonly Single: "singleColor"; readonly Match: "colorMatch"; }
WebChartLegendPositions
- Type
- { readonly Left: "left"; readonly Right: "right"; readonly Top: "top"; readonly Bottom: "bottom"; }
WebChartStackedKinds
- Type
- { readonly Side: "sideBySide"; readonly Stacked: "stacked"; readonly Stacked100: "stacked100"; }
WebChartBoxPlotMultipleSeriesKinds
- Type
- { readonly Side: "sideBySide"; readonly MeanLines: "meanLines"; }
WebChartLineSmoothedKinds
Represents the different types of smoothing that can be applied to a line chart when the lineSmoothed property is set to true.
- Type
- { readonly Bezier: "bezier"; readonly MonotoneX: "monotoneX"; readonly MonotoneY: "monotoneY"; }
WebChartTemporalBinningUnits
The temporal binning units
- Type
- { readonly Second: "seconds"; readonly Minute: "minutes"; readonly Hour: "hours"; readonly Day: "days"; readonly Week: "weeks"; readonly Month: "months"; readonly Quarter: "quarters"; readonly Year: "years"; }
WebChartCalendarDatePartsUnits
Represents the units that can be used for calendar-based date parts binning.
- Type
- { readonly DayOfMonth: "dayOfMonth"; readonly DayOfWeek: "dayOfWeek"; readonly DayOfYear: "dayOfYear"; readonly HourOfDay: "hourOfDay"; readonly MonthOfYear: "monthOfYear"; readonly MinuteOfDay: "minuteOfDay"; readonly WeekOfYear: "weekOfYear"; readonly QuarterOfYear: "quarterOfYear"; }
WebChartCalendarBinningOffsetUnits
The temporal binning units for the calendar based binning offset
- Type
- { readonly Second: "seconds"; readonly Minute: "minutes"; readonly Hour: "hours"; readonly Day: "days"; }
WebChartHeatChartHeatRulesTypes
Represents the different types of heat rule that can be applied to a heat chart.
- Type
- { readonly Gradient: "gradient"; readonly Renderer: "renderer"; }
WebChartNullPolicyTypes
Represents the different types of null policy that can be applied to a chart using the time binning feature.
- Type
- { readonly Null: "null"; readonly Zero: "zero"; readonly Interpolate: "interpolate"; }
WebChartTimeAggregationTypes
Represents the different types of time aggregation that can be applied to a chart using the time binning feature.
- Type
- { readonly Start: "equalIntervalsFromStartTime"; readonly End: "equalIntervalsFromEndTime"; }
WebChartLabelBehavior
Represents the different types of behaviors that can applied to a chart axis.
- Type
- { readonly Hide: "hide"; readonly Rotate: "rotate"; readonly Stagger: "stagger"; readonly Wrap: "wrap"; }
WebChartVersionStatus
- Type
- { readonly Same: "same"; readonly Newer: "newer"; readonly Older: "older"; readonly Unrecognized: "unrecognized"; }
WebChartAxisTypes
Represents the different types of axes that can be used in a chart.
- Type
- { readonly Value: "value"; readonly Date: "date"; readonly Category: "category"; }
GaugeChartSubTypes
Represents the different types of gauge charts.
- Type
- { readonly FeatureGauge: "featureGauge"; readonly StatisticGauge: "statisticGauge"; }
SizePolicyScaleTypes
Represents the types of scales that can be applied to the size policy. Use by bubble charts (scatterplot).
- Type
- { readonly Linear: "linear"; readonly Logarithmic: "logarithmic"; }
WebChartRadarChartAxisLabelsOrientation
Labels orientation for radar chart axes.
- Type
- { readonly Radial: "radial"; readonly Circular: "circular"; readonly Horizontal: "horizontal"; }
WebChartOrderDataByTypes
The types of order assocated with chart data.
- Type
- { readonly YValue: "arcgis-charts-y-value"; readonly Mean: "arcgis-charts-mean"; readonly Median: "arcgis-charts-median"; readonly Category: "arcgis-charts-category"; readonly MultiAxes: "arcgis-charts-multi-axes"; }
WebChartHeatChartViewTypes
Represents the different types of views that can be applied to a heat chart.
- Type
- { readonly singleCalendarView: "SingleCalendarView"; readonly sequentialCalendarViews: "SequentialCalendarViews"; }
WebChartClassBreakTypes
Class break types for data classification in charts.
- Type
- { readonly equalInterval: "equal-interval"; readonly quantile: "quantile"; readonly naturalBreaks: "natural-breaks"; readonly manual: "manual"; }
Type definitions
WebChartTypes
- Type
- (typeof WebChartTypes)[keyof typeof WebChartTypes]
WebChartStatisticType
- Type
- (typeof WebChartStatisticType)[keyof typeof WebChartStatisticType]
WebChartDataTransformations
- Type
- (typeof WebChartDataTransformations)[keyof typeof WebChartDataTransformations]
WebChartColoringPatterns
- Type
- (typeof WebChartColoringPatterns)[keyof typeof WebChartColoringPatterns]
WebChartLegendPositions
- Type
- (typeof WebChartLegendPositions)[keyof typeof WebChartLegendPositions]
WebChartStackedKinds
- Type
- (typeof WebChartStackedKinds)[keyof typeof WebChartStackedKinds]
WebChartBoxPlotMultipleSeriesKinds
- Type
- (typeof WebChartBoxPlotMultipleSeriesKinds)[keyof typeof WebChartBoxPlotMultipleSeriesKinds]
WebChartSortOrderKinds
- Type
- (typeof WebChartSortOrderKinds)[keyof typeof WebChartSortOrderKinds]
WebChartLineSmoothedKinds
- Type
- (typeof WebChartLineSmoothedKinds)[keyof typeof WebChartLineSmoothedKinds]
WebChartTemporalBinningUnits
- Type
- (typeof WebChartTemporalBinningUnits)[keyof typeof WebChartTemporalBinningUnits]
WebChartCalendarDatePartsUnits
- Type
- (typeof WebChartCalendarDatePartsUnits)[keyof typeof WebChartCalendarDatePartsUnits]
WebChartCalendarBinningOffsetUnits
- Type
- (typeof WebChartCalendarBinningOffsetUnits)[keyof typeof WebChartCalendarBinningOffsetUnits]
WebChartHeatChartHeatRulesTypes
- Type
- (typeof WebChartHeatChartHeatRulesTypes)[keyof typeof WebChartHeatChartHeatRulesTypes]
WebChartNullPolicyTypes
- Type
- (typeof WebChartNullPolicyTypes)[keyof typeof WebChartNullPolicyTypes]
WebChartTimeAggregationTypes
- Type
- (typeof WebChartTimeAggregationTypes)[keyof typeof WebChartTimeAggregationTypes]
WebChartLabelBehavior
- Type
- (typeof WebChartLabelBehavior)[keyof typeof WebChartLabelBehavior]
WebChartVersionStatus
- Type
- (typeof WebChartVersionStatus)[keyof typeof WebChartVersionStatus]
WebChartAxisTypes
- Type
- (typeof WebChartAxisTypes)[keyof typeof WebChartAxisTypes]
GaugeChartSubTypes
- Type
- (typeof GaugeChartSubTypes)[keyof typeof GaugeChartSubTypes]
SizePolicyScaleTypes
- Type
- (typeof SizePolicyScaleTypes)[keyof typeof SizePolicyScaleTypes]
WebChartRadarChartAxisLabelsOrientation
- Type
- (typeof WebChartRadarChartAxisLabelsOrientation)[keyof typeof WebChartRadarChartAxisLabelsOrientation]
WebChartOrderDataByTypes
- Type
- (typeof WebChartOrderDataByTypes)[keyof typeof WebChartOrderDataByTypes]
WebChartMultiAxesDataOrder
A data order option that allows the items to be ordered on both the x- and y-axes;
For each axis, the order can be either a direction (ascending or descending) for all axis types; or a predefined list of labels when the axis is categorical.
orderByX
- Type
- string[] | WebChartSortOrderKinds | undefined
The direction of the order for the x axis. If the axis is categorical, this can also be a predefined list of labels.
orderByY
- Type
- string[] | WebChartSortOrderKinds | undefined
The direction of the order for the y axis. If the axis is categorical, this can also be a predefined list of labels.
WebChartDirectionalDataOrder
A data order option that allows the items to be ordered either ascending or descending. This option can be used for the following types of order: by category, by mean, by median, and by y value.
preferLabel
Indicates whether to order data by the label or the value.
For example, when a field has domain coded values or supbtypes, setting this property to false will order the data by the field value.
Otherwise the domain description, subtypes description, or the alias of the field will be used to sort the data.
- Default value
- true
WebChartPredefinedLabelsDataOrder
A data order option that allows the items to be ordered by category based on a predefined list of labels.
orderBy
- Type
- string[]
The predefined list of labels to order the data by.
When the value of the preferLabel property is set to false, the orderBy list should be a list of
coded domain values or field names; otherwise, it should be a list of domain descriptions, subtypes descriptions, or field aliases.
preferLabel
Indicates whether to order data by the label or the value.
For example, when a field has domain coded values or supbtypes, setting this property to false will order the data by the field value.
Otherwise the domain description, subtypes description, or the alias of the field will be used to sort the data.
When the value is set to true or undefined, the orderBy property should contain a list of labels like domain descriptions, subtypes descriptions, or field aliases.
When the value is set to false, the orderBy property should contain a list of coded domain values or field names, in order for the data to be sorted correctly.
- Default value
- true
WebChartOrderSeriesBy
Order options for split-by series.
orderBy
- Type
- WebChartSortOrderKinds | undefined
The direction of the order.
- Default value
- WebChartSortOrderKinds.Ascending
WebChartHeatChartViewTypes
- Type
- (typeof WebChartHeatChartViewTypes)[keyof typeof WebChartHeatChartViewTypes]
WebChartClassBreakTypes
Class break types for data classification in charts.
- Type
- (typeof WebChartClassBreakTypes)[keyof typeof WebChartClassBreakTypes]