import type { Axes, Position, Mode, ConversionInfo, ConvertFunction } from "@arcgis/core/widgets/types.js";Type definitions
Position
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes a point in terms of a location, a Point, and a coordinate, a string.
ConversionInfo
- Since
- ArcGIS Maps SDK for JavaScript 5.0
This object describes how a Format should be projected and formatted for display. Used to define custom Formats that require custom conversion and/or projection logic.
convert
- Type
- ConvertFunction | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A function that takes a point and returns a Position.
reverseConvert
- Type
- ReverseConvertFunction | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A function that takes a string and returns a Point.
ConvertFunction
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A user-provided function that converts a Point into a Position. This function may be necessary to provide as part of ConversionInfo when creating a custom Format.
ReverseConvertFunction
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A user-provided function that converts a coordinate string into a Point. This function may be necessary to provide as part of ConversionInfo when creating a custom Format.
CoordinateSegment
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A coordinate segment represents one piece of a coordinate string.
A MGRS coordinate, for example 30UVG898998, is described by four segments:
- Alias
Z, the gridzone:30U - Alias
S, the 100,000 meter square designator:VG - Alias
X, the easting (x coordinate with respect to the 10,000 meter square):898 - Alias
Y, the northing (y coordinate with respect to the 10,000 meter square):998
alias
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A string that provides the name for this segment of a coordinate string.
description
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A string that describes the role of this segment.
searchPattern
- Type
- RegExp
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A regular expression that should extract this segment from the complete coordinate.
LayerInfo
- Since
- ArcGIS Maps SDK for JavaScript 5.0
An object that defines a layer, optional sublayer IDs, and a custom title for legend display. Use this to specify which layers and sublayers appear in the legend and how they are labeled with layerInfos.
title
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Specifies a title for the layer to display above its symbols and descriptions. If no title is specified the service name is used.
sublayerIds
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The IDs of the sublayers for which to display legend information.
Only applicable if the layer is a MapImageLayer, SubtypeGroupLayer
or WMSLayer.
LegendElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Properties defining the scheme of each of the supported legendElement.
SymbolTableElementType
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Properties defining the scheme of each SymbolTableElementType.
SymbolTableElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the SymbolTableElement used as a legendElement. This legend element is used for UniqueValueRenderer and ClassBreaksRenderer.
title
- Type
- RendererTitle | DotDensityTitle | string | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The title of the renderer as displayed in the legend.
infos
- Type
- SymbolTableElementType[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
An array of each symbol/category/break rendered for the symbol table. For example, this may be individual breaks for a ClassBreaksRenderer, or unique values for a UniqueValueRenderer.
SymbolTableElementInfo
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Properties defining the scheme of the SymbolTableElementInfo.
symbol
- Type
- SymbolUnion
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The symbol for the corresponding value in the legend.
preview
- Type
- HTMLElement | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A preview of the symbol element as displayed in the legend.
previewAriaLabel
- Type
- RendererTitle | DotDensityTitle | string | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The aria-label for the preview element.
ImageSymbolTableElementInfo
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Properties defining the scheme of each of the ImageSymbolTableElementInfo. This applies only to ImageryLayer renderers.
label
- Type
- StretchMultibandTitle | string | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The label of the category corresponding to the given image.
src
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The data URI of the image representing a colored pixel in the renderer.
previewAriaLabel
- Type
- RendererTitle | DotDensityTitle | string | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The aria-label for the preview element.
ColorRampElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the ColorRampElement used as a legendElement.
infos
- Type
- ColorRampStop[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The individual color stops rendered in the legend that correspond to the color visual variable in the renderer.
preview
- Type
- HTMLElement | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A preview of the element as displayed in the legend.
StretchRampElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the StretchRampElement used as a legendElement.
infos
- Type
- ColorRampStop[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The individual color stops rendered in the legend that correspond to the color visual variable in the renderer.
preview
- Type
- HTMLElement | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A preview of the element as displayed in the legend.
OpacityRampElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the OpacityRampElement used as a legendElement.
infos
- Type
- OpacityRampStop[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The individual opacity stops rendered in the legend that correspond to the opacity visual variable in the renderer.
preview
- Type
- HTMLElement | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A preview of the element as displayed in the legend.
SizeRampElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the SizeRampElement used as a legendElement.
title
- Type
- ClusterTitle | RampTitle | string | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The title of the size ramp as displayed in the legend.
infos
- Type
- SizeRampStop[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The individual size stops rendered in the legend that correspond to the size visual variable in the renderer.
HeatmapRampElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the HeatmapRampElement used as a legendElement.
title
- Type
- RendererTitle | string | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The title of the heatmap ramp as displayed in the legend.
infos
- Type
- HeatmapRampStop[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The individual color stops rendered in the legend that correspond to the heatmap colorStops in the renderer.
preview
- Type
- HTMLElement | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A preview of the element as displayed in the legend.
RelationshipRampElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the RelationshipRampElement used as a legendElement.
numClasses
- Type
- number
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The number of classes for each field comprising the renderer. Can either be 2, 3, or 4.
focus
- Type
- RelationshipFocus
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Determines the orientation of the Legend. Values can be HH, HL, LH, LL.
colors
- Type
- Color[][]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A 2-dimensional array of colors as displayed in the legend grid.
labels
- Type
- RelationshipLabels
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The labels for each corner of the legend.
rotation
- Type
- number
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The rotation of the legend in degrees (0-360). 0 degrees displays the legend
as a square with the LL cell in the bottom left corner of the legend and the HH cell in the top right corner.
UnivariateColorSizeRampElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the UnivariateColorSizeRampElement used as a legendElement.
title
- Type
- ClusterTitle | RampTitle | string | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The title of the color ramp as displayed in the legend.
infos
- Type
- (SizeRampElement | ColorRampElement)[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The individual color stops rendered in the legend that correspond to the color visual variable in the renderer.
PieChartRampElement
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the UnivariateColorSizeRampElement used as a legendElement.
title
- Type
- RendererTitle | string | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The title of the color ramp as displayed in the legend.
infos
- Type
- SymbolTableElementInfo[]
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The individual color stops rendered in the legend that correspond to the color visual variable in the renderer.
preview
- Type
- HTMLElement | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A preview of the element as displayed in the legend.
RendererTitle
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the RendererTitle element.
DotDensityTitle
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the DotDensityTitle element.
ClusterTitle
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the ClusterTitle element.
RampTitle
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the RampTitle element.
ratio
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, the legend formats to display the field and normalization field as a ratio.
ratioPercent
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, the legend formats to display the field and normalization field as a percentage.
ratioPercentTotal
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, the legend formats to display the field and normalization field as a percentage of total.
StretchMultibandTitle
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the StretchMultibandTitle element.
SizeRampStop
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the SizeRampStop element. Each SizeRampStop represents a single stop of the SizeVariable referenced in the renderer.
label
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The label in the legend describing features with the given symbol and value.
symbol
- Type
- SymbolUnion
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The symbol corresponding to the value of the stop in the renderer.
preview
- Type
- HTMLElement | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The HTML element rendered in the legend representing features with the given value.
ColorRampStop
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the ColorRampStop element. Each ColorRampStop represents a single stop of the ColorVariable referenced in the renderer.
OpacityRampStop
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the OpacityRampStop element. Each OpacityRampStop represents a single stop of the
OpacityVariable referenced in the renderer. The opacity value of
each stop is indicated in the alpha property of the color object.
label
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The label in the legend describing features with the given color and value.
HeatmapRampStop
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the HeatmapRampStop element. Each HeatmapRampStop represents a single colorStop of the
Heatmap color stops referenced in the renderer.
color
- Type
- Color
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The color of the pixel corresponding to the appropriate pixel ratio. This value is typically
between 0 and 1.
ratio
- Type
- number
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The ratio of a pixel's intensity value to the minPixelIntensity of the renderer. The ratio of each pixel is matched to the corresponding color.
label
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The label of the color stop displayed in the legend. Typically only the first and last stops have labels.
RelationshipLabels
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Describes the schema of the RelationshipLabels element. These labels are rendered in the corners of the square that represent the relationship renderer in the legend.
top
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The label corresponding with the top corner of the legend if the focus
is set to HH. This
describes values that are considered high in both field 1 and field 2 (HH).
bottom
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The label corresponding with the bottom corner of the legend if the focus is
set to HH. This
describes values that are considered low in both field 1 and field 2 (LL).
left
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The label corresponding with the left corner of the legend (if the focus
is set to HH). This describes features where the value of field 1 is high and the value of field 2 is low (HL).
right
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The label corresponding with the right corner of the legend (if the focus
is set to HH). This describes features where the value of field 2 is high and the value of field 1 is low (LH).
AttributionItem
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The following properties define an attribution item that contains the attribution text for a layer.
layerView
- Type
- LayerView
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The layer view that has the attribution text.
MeasurementState
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "disabled" | "ready" | "measuring" | "measured"
SliderFormatType
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "average" | "min" | "max" | "tick" | "value"
HistogramLabelFormatFunction
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Function used to format labels. This function should be set to the Histogram.labelFormatFunction property. This function fires every time a label is created or updated on the histogram.
LabelFormatFunction
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Function used to format labels. This function should be set to the Slider.labelFormatFunction property. It fires each time a label is created or updated on the slider.
InputFormatFunction
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Function used to format thumb labels. This function should be set to the SmartMappingSliderBase.labelFormatFunction property. This function fires every time a label is created or updated on the slider.
- Supertypes
- LabelFormatFunction
InputParseFunction
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Function definition for the Slider.inputParseFunction property. It fires each time the user modifies slider input by key entry.
Parameters
- Returns
- number
The parsed number value of the thumb.