Types
import type { VisualVariableStop, SmartMappingSupportedStop, SupportedBreaks, ViewModelState, ZoomOptions } from "@arcgis/core/widgets/smartMapping/types.js";

Type definitions

VisualVariableStop

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

SmartMappingSupportedStop

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

SupportedBreaks

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

ViewModelState

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"disabled" | "ready"

ZoomOptions

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

max

Property
Type
number | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The upper bound of the zoom.

min

Property
Type
number | null | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The lower bound of the zoom.

HistogramConfig

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Configuration options for defining the slider's Histogram.

average

Property
Type
number | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates the average value of the dataset. When set, a solid line on the histogram will render at the location of the average value along with a label defaulting to the value set here.

barCreatedFunction

Property
Type
BarCreatedFunction | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Function for styling bars representing histogram bins. This can be used to style bins or add custom interaction to them. For example, you can use this function to color bins that match the colors on the slider's track.

bins

Property
Type
HistogramBin[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The bins of the histogram. This is an array of objects indicating the range and count of data in each bin. This value is typically retrieved from the histogram function.

dataLines

Property
Type
DataLineInfos[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

When set, renders lines on the histogram that indicate important or meaningful values to the end user.

dataLineCreatedFunction

Property
Type
DataLineCreatedFunction | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Function that fires each time a data line is created. You can use this to style individual dataLines on the data axis.

standardDeviation

Property
Type
number | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates the standard deviation of the dataset. When set, data lines are on the histogram at the locations of the standard deviations above and below the average.

standardDeviationCount

Property
Type
number | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates the standard deviation of the dataset. When set, data lines are on the histogram at the locations of the standard deviations above and below the average.

GradientStopInfo

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

The return object of the getStopInfo() and getColorStopInfo() methods.

color

Property
Type
Color
Since
ArcGIS Maps SDK for JavaScript 5.0

The color of the stop.

offset

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The offset of the stop.

ColorBreak

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

color

Property
Type
Color
Since
ArcGIS Maps SDK for JavaScript 5.0

Features with values within the provided min and max will be rendered with this color.

max

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The max value of the break. The max of each break should match the min value of the break directly above it.

min

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The min value of the break. The min of each break should match the max value of the break directly below it.

SizeBreak

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

size

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The size in points of the symbol representing features with values within the given min and max.

max

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The max value of the break. The max of each break should match the min value of the break directly above it.

min

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The min value of the break. The min of each break should match the max value of the break directly below it.