Types
import type { Color, LabelPosition, FeatureTemplatePrototype, FeatureTemplateThumbnail, FieldType } from "@arcgis/core/portal/jsonTypes.js";

Type definitions

Color

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
[ number, number, number, number ] | [ number, number, number ]

LabelPosition

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"curved" | "parallel"

FeatureTemplatePrototype

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

attributes

Property
Type
Record<string, any> | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

FeatureTemplateThumbnail

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

contentType

Property
Type
"png" | "jpg" | "jpeg" | "image"
Since
ArcGIS Maps SDK for JavaScript 5.0

The MIME type of the image.

imageData

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The base64EncodedImageData presenting the thumbnail image.

width

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The width of the thumbnail.

height

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The height of the thumbnail.

FieldType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Supported field types.

Type
"esriFieldTypeSmallInteger" | "esriFieldTypeInteger" | "esriFieldTypeSingle" | "esriFieldTypeDouble" | "esriFieldTypeLong" | "esriFieldTypeString" | "esriFieldTypeDate" | "esriFieldTypeOID" | "esriFieldTypeGeometry" | "esriFieldTypeBlob" | "esriFieldTypeRaster" | "esriFieldTypeGUID" | "esriFieldTypeGlobalID" | "esriFieldTypeXML" | "esriFieldTypeBigInteger" | "esriFieldTypeDateOnly" | "esriFieldTypeTimeOnly" | "esriFieldTypeTimestampOffset"

Point

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

x

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The x coordinate of the anchor point, measured along the east/west axis.

y

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The y coordinate of the anchor point, measured along the north/south axis.

z

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

The z coordinate of the camera position.

m

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

The m value of the camera position.

spatialReference

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

The spatial reference of the camera position. If not specified, the spatial reference of the video layer is used.

Extent

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

An envelope is a rectangle defined by a range of values for each coordinate and attribute.

xmin

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The minimum X value in the area of the envelope.

ymin

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The minimum Y value in the area of the envelope.

xmax

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The maximum X value in the area of the envelope.

ymax

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The maximum Y value in the area of the envelope.

Coordinate

Type definition
Type
number[]

Coordinate2D

Type definition
Type
[ number, number ]

CircularArc

Type definition

c

Property
Type
[ endPoint: Coordinate, interiorPoint: Coordinate2D ]

The parameters of the arc:

  • End point
  • Interior point

EllipticArc7

Type definition

An elliptic arc definition.

See also

a

Property
Type
[ endPoint: Coordinate, centerPoint: Coordinate2D, isMinor: 0 | 1, isClockwise: 0 | 1, rotation: number, semiMajor: number, minorToMajorRatio: number ]

The parameters of the arc:

  • End point
  • Center point
  • Sweep flag: major (0) or minor (less than 180 degrees) (1)
  • Orientation flag: counter-clockwise (0) or clockwise (1)
  • Rotation angle in radians. Positive values in counter-clockwise direction.
  • Length of the semi-major axis
  • Ratio of minor to major axis

EllipticArc4

Type definition

Elliptic arc definition representing a circular arc.

This curve type is most commonly used to represent full circles.

a

Property
Type
[ endPoint: Coordinate, centerPoint: Coordinate2D, isMinor: 0 | 1, isClockwise: 0 | 1 ]

The parameters of the arc:

  • End point
  • Center point
  • Sweep flag: major (0) or minor (less than 180 degrees) (1)
  • Orientation flag: counter-clockwise (0) or clockwise (1)

EllipticArc

Type definition

BezierCurve

Type definition

A definition for a cubic bezier curve.

b

Property
Type
[ endPoint: Coordinate, controlPoint1: Coordinate2D, controlPoint2: Coordinate2D ]

The parameters of the bezier curve:

  • End point
  • Control point 1
  • Control point 2

Curve

Type definition

Compact representation of a curve segment.

All curve segments start from the end point of the previous segment.

Note: this type includes plain Coordinate because curve geometries may include straight line segments.

See also

VideoServiceLayerInfo

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

The VideoServiceLayerInfo defines layer information for video layers published within the same video service.

layerId

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The layer id of the video layer.

posterUrl

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The URL to the poster image for the video layer.

sourceType

Property
Type
VideoSourceType
Since
ArcGIS Maps SDK for JavaScript 5.0

The source type of the video layer.

title

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The title of the video layer.

type

Property
Type
"Video Layer"
Since
ArcGIS Maps SDK for JavaScript 5.0

The layer type. The type is always "Video Layer" for VideoLayers.

VideoSourceType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"ondemand" | "livestream"

VideoGroundControlPoint

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

lat

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The latitude.

lon

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The longitude.

x

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The x coordinate in pixels.

y

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The y coordinate in pixels.

VideoQuality

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"sd" | "hd" | "fhd" | "qhd" | "uhd"

Codecs

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

The Codecs is an object that represents the codecs used by the video layer.

audio

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The audio codec used in the video layer.

text

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The text codec used in the video layer.

video

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The video codec used in the video layer.

VideoCameraInfo

Type definition
Since
ArcGIS Maps SDK for JavaScript 4.34

The CameraInfo is an object that represents the camera information of the video layer.

farDistance

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The far distance of the camera in meters.

fov

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The field of view of the camera in degrees.

heading

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The heading of the camera in degrees.

height

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The height of the camera in meters.

nearDistance

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The near distance of the camera in meters.

position

Property
Type
Point
Since
ArcGIS Maps SDK for JavaScript 5.0

The position of the camera.

tilt

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

The tilt of the camera in degrees.

Feature

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

A JSON Feature object that can be added to a StreamLayer on the client by calling its sendMessageToClient() method. It is an esri Feature JSON object as defined in the Feature object specification.

geometry

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

A location of the received data containing x, y coordinates for points, paths for lines, and rings for polygons, along with the spatial reference wkid.

attributes

Property
Type
Record<string, any>
Since
ArcGIS Maps SDK for JavaScript 5.0

Name-value pairs of fields and field values associated with the received data.

GeometryType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"esriGeometryPoint" | "esriGeometryPolyline" | "esriGeometryPolygon" | "esriGeometryEnvelope" | "esriGeometryMultiPatch" | "esriGeometryMultipoint"

SimpleTransformation

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

wkid

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

the spatial reference well known id

CompositeTransformation

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

geoTransforms

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

GeoTransform

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

wkid

Property
Type
number
Since
ArcGIS Maps SDK for JavaScript 5.0

the spatial reference well known id.

transformForward

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

indicates whether to transform forward or not.

DatumTransformation

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

SQLFormat

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"none" | "native" | "standard"

Progressor

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

message

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Progress message.

percent

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

Progress percentage.

FormElementType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"field" | "attachment" | "group" | "relationship" | "text" | "utilityNetworkAssociations"

TimeResolution

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"minutes" | "seconds"

TimeResolutionMS

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
TimeResolution | "milliseconds"

InputMethod

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"any" | "capture" | "upload"

FormAttachmentAssociationType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"any" | "exact" | "exactOrNone"

GroupState

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"collapsed" | "expanded"

TextFormatType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"plain-text" | "markdown"

FormExpressionReturnType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"boolean" | "date" | "number" | "string"

TableElementType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"group" | "field" | "attachment" | "relationship"

LayoutType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"basic-grid" | "chronological-mono-timeline" | "chronological-multi-timeline" | "geographic-organic-standard" | "hierarchical-bottom-to-top" | "hierarchical-top-to-bottom" | "organic-community" | "organic-fusiform" | "organic-leaf-circle" | "organic-standard" | "radial-node-centric" | "radial-root-centric" | "tree-bottom-to-top" | "tree-left-to-right" | "tree-right-to-left" | "tree-top-to-bottom"

TimeDirection

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"bottom" | "left" | "right" | "top"