Types
import type { ParameterTypes, SingleDataType, SingleParameterValue, MultipleParameterValue, ParameterValueTemplate } from "@arcgis/core/rest/types.js";

Type definitions

ParameterTypes

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

SingleDataType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"areal-unit" | "boolean" | "composite" | "data-file" | "date" | "double" | "feature-record-set-layer" | "field" | "linear-unit" | "long" | "raster-data" | "raster-data-layer" | "record-set" | "string" | "time-unit" | "value-table"

SingleParameterValue

Type definition
Type parameters
<T extends SingleDataType, U extends ParameterTypes>
Since
ArcGIS Maps SDK for JavaScript 5.0

dataType

Property
Type
T
Since
ArcGIS Maps SDK for JavaScript 5.0

value

Property
Type
U
Since
ArcGIS Maps SDK for JavaScript 5.0

MultipleParameterValue

Type definition
Type parameters
<T extends SingleDataType, U extends ParameterTypes>
Since
ArcGIS Maps SDK for JavaScript 5.0

dataType

Property
Type
multi-value-${T}
Since
ArcGIS Maps SDK for JavaScript 5.0

value

Property
Type
U[]
Since
ArcGIS Maps SDK for JavaScript 5.0

ParameterValueTemplate

Type definition
Type parameters
<T extends SingleDataType, U extends ParameterTypes>
Since
ArcGIS Maps SDK for JavaScript 5.0

ParameterValue

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

PrintResponse

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Represents the response of the execute() method.

Supertypes
default

LocationType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"rooftop" | "street"

Transformation

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

wkid

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

The well-known ID of the datum transformation to apply to the projection. List of valid IDs for Datum transformations.

wkt

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

The well-known text that defines a spatial reference.

GenerateSymbolResponse

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

The response of the generateSymbol() method.

symbol

Property
Type
CIMSymbol
Since
ArcGIS Maps SDK for JavaScript 5.0

The CIMSymbol created from the generateSymbol() method.

GenerateSymbolParameters

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Input parameters for the generateSymbol() method.

svgImage

Property
Type
string | FormData | HTMLFormElement | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The SVG image to convert. Can be an SVG string value, form data, or form element. When providing the SVG from FormData or HTMLFormElement, the name of the element in the form must be "svgImage". When providing the SVG from a string, the XML namespace (xmlns) must be defined.

WaitForJobOptions

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Supertypes
AbortOptions

interval

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

The time in millisecond between remote job status requests.

Default value
1000

statusCallback

Property
Type
(jobInfo: JobInfo) => void | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Callback function that is called at the specified interval. Use this method to monitor job status and messages.

apiKey

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

An authorization string used to access a resource or service.

LayerMetadata

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

uniqueIdFields

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

The FeatureLayer.uniqueIdFields of the FeatureLayer. Specify this parameter, if the FeatureLayer.uniqueIdFields uses non-numeric unique IDs.