Types
import type { LayerType, LayerListMode, EditableLayerUnion, LayerWithFeatureTemplatesUnion, EditingInfo } from "@arcgis/core/layers/types.js";
Since
ArcGIS Maps SDK for JavaScript 5.0

A module for importing types used in Layer modules.

Type definitions

LayerType

Type definition

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

See also
Type
"base-dynamic" | "base-elevation" | "base-tile" | "bing-maps" | "building-scene" | "catalog" | "catalog-footprint" | "catalog-dynamic-group" | "csv" | "dimension" | "elevation" | "feature" | "geo-rss" | "geojson" | "parquet" | "gaussian-splat" | "graphics" | "group" | "imagery" | "imagery-tile" | "integrated-mesh" | "integrated-mesh-3dtiles" | "kml" | "knowledge-graph" | "knowledge-graph-sublayer" | "line-of-sight" | "link-chart" | "map-image" | "map-notes" | "media" | "video" | "ogc-feature" | "open-street-map" | "oriented-imagery" | "point-cloud" | "route" | "scene" | "stream" | "subtype-group" | "tile" | "unknown" | "unsupported" | "vector-tile" | "viewshed" | "voxel" | "wcs" | "web-tile" | "wfs" | "wms" | "wmts"

LayerListMode

Type definition

Indicates how the layer should display in the Layer List component. The possible values are listed below.

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
hide-childrenIf the layer is a GroupLayer, BuildingSceneLayer, KMLLayer, MapImageLayer, SubtypeGroupLayer, TileLayer, or WMSLayer, hide the children layers from the table of contents.
See also
Type
"show" | "hide" | "hide-children"

EditableLayerUnion

Type definition

A collection of editable layers. Layers are considered editable if they have editing capabilities, and if the authenticated user has the necessary privileges needed to edit the layers.

See also

LayerWithFeatureTemplatesUnion

Type definition

Union of layer types that support feature templates.

EditingInfo

Type definition
Since
ArcGIS Maps SDK for JavaScript 4.12

Specifies information about editing.

lastEditDate

Property
Type
Date | null | undefined

Indicates the last time the layer was edited. This value gets updated every time the layer's data is edited or when any of its properties change.

SupportedSpatialAggregationStatistics

Type definition

Indicates which spatial aggregation statistic geometries are supported.

envelope

Property
Type
boolean

Indicates if the layer can return extent for each distinct group for Query.groupByFieldsForStatistics.

centroid

Property
Type
boolean

Indicates if the layer can return centroid for each distinct group for Query.groupByFieldsForStatistics.

convexHull

Property
Type
boolean

Indicates if the layer can return convex hull for each distinct group for Query.groupByFieldsForStatistics.

SupportedBinStatistics

Type definition

Indicates which statistics are supported for attribute binning queries.

See also

count

Property
Type
boolean | undefined

Indicates if the layer supports count statistics function.

sum

Property
Type
boolean | undefined

Indicates if the layer supports sum statistics function.

avg

Property
Type
boolean | undefined

Indicates if the layer supports avg statistics function.

var

Property
Type
boolean | undefined

Indicates if the layer supports var statistics function.

stddev

Property
Type
boolean | undefined

Indicates if the layer supports stddev statistics function.

min

Property
Type
boolean | undefined

Indicates if the layer supports min statistics function.

max

Property
Type
boolean | undefined

Indicates if the layer supports max statistics function.

percentileContinuous

Property
Type
boolean | undefined

Indicates if the layer supports percentileContinuous statistics function.

percentileDiscrete

Property
Type
boolean | undefined

Indicates if the layer supports percentileDiscrete statistics function.

SupportedBinNormalizationTypes

Type definition

Indicates which normalization types are supported for attribute binning queries.

field

Property
Type
boolean | undefined

Indicates if the queryAttributeBins supports field normalization.

log

Property
Type
boolean | undefined

Indicates if the queryAttributeBins supports log normalization.

naturalLog

Property
Type
boolean | undefined

Indicates if the queryAttributeBins supports natural log normalization.

percentOfTotal

Property
Type
boolean | undefined

Indicates if the queryAttributeBins supports percent of total normalization.

squareRoot

Property
Type
boolean | undefined

Indicates if the queryAttributeBins supports square root normalization.

DataCapabilities

Type definition

Describes characteristics of the data in the layer as part of its FeatureLayerCapabilities.

See also

isVersioned

Property
Type
boolean

Indicates if the feature service is versioned.

isBranchVersioned

Property
Type
boolean

Indicates if the feature service is branch versioned.

supportedCurveTypes

Property
Type
readonly CurveType[]

The types of true curves the layer supports.

supportsAttachment

Property
Type
boolean

Indicates if the attachment is enabled on the layer.

supportsM

Property
Type
boolean

Indicates if the features in the layer support m-values.

supportsTrueCurve

Property
Type
boolean

Indicates if the layer supports geometries with true curves.

supportsZ

Property
Type
boolean

Indicates if the features in the layer support z-values. See FeatureLayer.elevationInfo for details regarding placement and rendering of features with z-values in 3D SceneViews.

MetadataCapabilities

Type definition

Describes the metadata contained on features in the layer as part of its FeatureLayerCapabilities.

supportsAdvancedFieldProperties

Property
Type
boolean

Indicates whether to provide a user-defined field description. See Describe attribute fields for additional information.

OperationCapabilities

Type definition

Describes operations that can be performed on features in the layer as part of its FeatureLayerCapabilities.

supportsAdd

Property
Type
boolean

Indicates if new features can be added to the layer.

supportsCalculate

Property
Type
boolean

Indicates if values of one or more field values in the layer can be updated. See the Calculate REST operation document for more information.

supportsDelete

Property
Type
boolean

Indicates if features can be deleted from the layer.

supportsEditing

Property
Type
boolean

Indicates if features in the layer can be edited. Use supportsAdd, supportsUpdate and supportsDelete to determine which editing operations are supported.

supportsQuery

Property
Type
boolean

Indicates if features in the layer can be queried.

supportsQueryAttachments

Property
Type
boolean

Indicates if the layer supports REST API queryAttachments operation. If false, queryAttachments() method can only return attachments for one feature at a time. If true, queryAttachments() can return attachments for array of AttachmentQuery.objectIds.

supportsQueryTopFeatures

Property
Type
boolean

Indicates if the layer supports REST API queryTopFeatures operation.

supportsResizeAttachments

Property
Type
boolean

Deprecated since 4.24. Use attachment.supportsResize instead. Indicates if resized attachments are supported in the feature layer. This is useful for showing thumbnails in Popups.

supportsUpdate

Property
Type
boolean

Indicates if features in the layer can be updated.

supportsValidateSql

Property
Type
boolean

Indicates if the layer supports a SQL-92 expression or where clause.

QueryCapabilities

Type definition

Describes Query operations that can be performed on features in the layer.

maxRecordCount

Property
Type
number | null | undefined

The maximum number of records that will be returned for a given query.

maxUniqueIDCount

Property
Type
number | null | undefined

The maximum number of unique-ids that will be returned for a given query.

supportedSpatialAggregationStatistics

Property
Type
SupportedSpatialAggregationStatistics

List of supported aggregated geometries returned for each distinct group when Query.groupByFieldsForStatistics is used.

supportsCacheHint

Property
Type
boolean

Indicates if the query operation supports a cache hint. This is valid only for hosted feature services.

supportsCentroid

Property
Type
boolean

Indicates if the geometry centroid associated with each polygon feature can be returned. This operation is only supported in ArcGIS Online hosted feature services.

supportsDisjointSpatialRelationship

Property
Type
boolean

Indicates if the query operation supports disjoint spatial relationship. This is valid only for hosted feature services.

supportsDistance

Property
Type
boolean

Indicates if the layer's query operation supports a buffer distance for input geometries.

supportsDistinct

Property
Type
boolean

Indicates if the layer supports queries for distinct values based on fields specified in the FeatureLayer.outFields.

supportsExtent

Property
Type
boolean

Indicates if the layer's query response includes the extent of features. At 10.3, this option is only available for hosted feature services. At 10.3.1, it is available for hosted and non-hosted feature services.

supportsGeometryProperties

Property
Type
boolean

Indicates if the layer's query response contains geometry attributes, including shape area and length attributes. This operation is supported in ArcGIS Online hosted feature services created since December 2016 and ArcGIS Enterprise feature services since version 10.7.

supportsHavingClause

Property
Type
boolean

Indicates if the layer supports the Query.having clause on the service. Requires an ArcGIS Server service 10.6.1 or greater.

supportsHistoricMoment

Property
Type
boolean

Indicates if the layer supports historic moment query. Requires ArcGIS Server service 10.5 or greater.

supportsMaxRecordCountFactor

Property
Type
boolean

Indicates if the layer supports Query.maxRecordCountFactor on the service.

supportsOrderBy

Property
Type
boolean

Indicates if the query response can be ordered by one or more fields. Requires an ArcGIS Server service 10.3 or greater.

supportsPagination

Property
Type
boolean

Indicates if the query response supports pagination. Requires an ArcGIS Server service 10.3 or greater.

supportsPercentileStatistics

Property
Type
boolean

Indicates if the layer supports percentile statisticType. Requires an ArcGIS Server service 10.7 or greater.

supportsQuantization

Property
Type
boolean

Indicates if the query operation supports the projection of geometries onto a virtual grid. Requires an ArcGIS Server service 10.6.1 or greater.

supportsQuantizationEditMode

Property
Type
boolean

Indicates if the query operation supports quantization designed to be used in edit mode (highest resolution at the given spatial reference). Requires an ArcGIS Server service 10.6.1 or greater.

supportsQueryGeometry

Property
Type
boolean

Indicates if the query response includes the query geometry. This is valid only for hosted feature services.

supportsResultType

Property
Type
boolean

Indicates if the number of features returned by the query operation can be controlled.

supportsReturnMesh

Property
Type
boolean

Indicates if queries support returning Mesh geometries. This is true for scene layers backed by a 3D Object feature layer.

supportsSpatialAggregationStatistics

Property
Type
boolean

Indicates if the layer supports spatial extent, center or convex hull to be returned for each distinct group when Query.groupByFieldsForStatistics is used. Supported with ArcGIS Online hosted features services only.

supportsSqlExpression

Property
Type
boolean

Indicates if the query operation supports SQL expressions.

supportsStandardizedQueriesOnly

Property
Type
boolean

Indicates if the query operation supports using standardized queries. Learn more about standardized queries here.

supportsStatistics

Property
Type
boolean

Indicates if the layer supports field-based statistical functions. Requires ArcGIS Server service 10.1 or greater.

supportsTrueCurve

deprecated Property
Type
boolean

Indicates if the layer supports geometries with true curves.

QueryRelatedCapabilities

Type definition

Indicates if the layer's query operation supports querying features or records related to features in the layer.

supportsCacheHint

Property
Type
boolean

Indicates if the relationship query operation supports a cache hint. This is valid only for hosted feature services.

supportsCount

Property
Type
boolean

Indicates if the layer's query response includes the number of features or records related to features in the layer.

supportsOrderBy

Property
Type
boolean

Indicates if the related features or records returned in the query response can be ordered by one or more fields.

supportsPagination

Property
Type
boolean

Indicates if the query response supports pagination for related features or records.

EditingCapabilities

Type definition

Describes editing capabilities that can be performed on the features in the layer via applyEdits().

supportsDeleteByAnonymous

Property
Type
boolean

Indicates if anonymous users can delete features created by others.

supportsDeleteByOthers

Property
Type
boolean

Indicates if logged in users can delete features created by others.

supportsGeometryUpdate

Property
Type
boolean

Indicates if the geometry of the features in the layer can be edited.

supportsGlobalId

Property
Type
boolean

Indicates if the globalId values provided by the client are used in FeatureLayer.applyEdits().

supportsRollbackOnFailure

Property
Type
boolean

Indicates if the rollbackOnFailureEnabled parameter can be set to true or false when editing features.

supportsTrueCurveUpdate

Property
Type
boolean

Indicates if feature geometries containing true curves can be updated.

supportsTrueCurveUpdateByTrueCurveClientsOnly

Property
Type
boolean

Indicates whether updates to true curves should be restricted to clients that support true editing. If true, applyEdits calls that update true curves must have the trueCurveClient parameter set to true.

supportsUpdateByAnonymous

Property
Type
boolean

Indicates if anonymous users can update features created by others.

supportsUpdateByOthers

Property
Type
boolean

Indicates if logged in users can update features created by others.

supportsUpdateWithoutM

Property
Type
boolean

Indicates if m-values must be provided when updating features.

supportsUploadWithItemId

Property
Type
boolean

Indicates if the layer supports uploading attachments by UploadId.

AttachmentCapabilities

Type definition

Describes what attachment capabilities are enabled on the layer as part of its FeatureLayerCapabilities.

supportsCacheHint

Property
Type
boolean

Indicates if the attachment operations support a cache hint. This is valid only for hosted feature services.

supportsContentType

Property
Type
boolean

Indicates if the attachments can be queried by their content types.

supportsExifInfo

Property
Type
boolean

Indicates if the attachment queries support exifInfo.

supportsKeywords

Property
Type
boolean

Indicates if the attachments can be queried by their keywords.

supportsName

Property
Type
boolean

Indicates if the attachments can be queried by their names.

supportsOrderByFields

Property
Type
boolean

Indicates if the queried attachments can be returned in order based on the specified attachmentInfo fields.

supportsResize

Property
Type
boolean

Indicates if resized attachments are supported in the feature layer. This is useful for showing thumbnails in Popups. See the feature service Attachment documentation for information on services that support resizing.

supportsSize

Property
Type
boolean

Indicates if the attachments can be queried by their sizes.

supportsTypeWildcard

Property
Type
boolean

Indicates if the attachments can be queried by using a wildcard character for attachment types.

AnalyticsCapabilities

Type definition

Describes what analytics capabilities are enabled on the layer as part of its FeatureLayerCapabilities.

supportsCacheHint

Property
Type
boolean

Indicates if the feature service supports cache hint.

QueryTopFeaturesCapabilities

Type definition

Describes top features query operations that can be performed on features in the layer as part of its FeatureLayerCapabilities.

supportsCacheHint

Property
Type
boolean

Indicates if the top query operation supports a cache hint. This is valid only for hosted feature services.

QueryBinsCapabilities

Type definition

Describes AttributeBinsQuery operations that can be performed on features in the layer.

supportsDate

Property
Type
boolean

Indicates if the layer supports date field-based attribute bins query functions.

supportsFixedInterval

Property
Type
boolean

Indicates if the layer supports fixed interval attribute bins query functions.

supportsAutoInterval

Property
Type
boolean

Indicates if the layer supports auto interval attribute bins query functions.

supportsFixedBoundaries

Property
Type
boolean

Indicates if the layer supports fixed boundaries attribute bins query functions.

supportsStackBy

Property
Type
boolean

Indicates if the layer supports the stackBy parameter in attribute bins query functions.

supportsSplitBy

Property
Type
boolean

Indicates if the layer supports the splitBy parameter in attribute bins query functions.

supportsSnapToData

Property
Type
boolean

Indicates if the layer's date field-based binning supports snapping data to either the first or last date point.

supportsReturnFullIntervalBin

Property
Type
boolean

When true all bins have equal intervals. When false the last bin's upper boundary maybe adjusted to the maximum value in the dataset.

supportsFirstDayOfWeek

Property
Type
boolean

Indicates if the first day of the week can be set for date binning.

supportsNormalization

Property
Type
boolean

Indicates if data can be transformed.

supportedStatistics

Property
Type
SupportedBinStatistics | null | undefined

Indicates if the layer supports statistics attribute bins query functions.

supportedNormalizationTypes

Property
Type
SupportedBinNormalizationTypes | null | undefined

Normalization types supported by the queryBins operation.

FeatureLayerCapabilities

Type definition

Describes the layer's supported capabilities.

analytics

Property
Type
AnalyticsCapabilities

Describes what analytics capabilities are enabled on the layer.

attachment

Property
Type
AttachmentCapabilities | null | undefined

Describes what attachment capabilities are enabled on the layer.

data

Property
Type
DataCapabilities

Describes characteristics of the data in the layer.

metadata

Property
Type
MetadataCapabilities

Describes the metadata contained on features in the layer.

operations

Property
Type
OperationCapabilities

Describes operations that can be performed on features in the layer.

query

Property
Type
QueryCapabilities

Describes Query operations that can be performed on features in the layer.

queryAttributeBins

Property
Type
QueryBinsCapabilities

Describes AttributeBinsQuery operations that can be performed on features in the layer.

queryRelated

Property
Type
QueryRelatedCapabilities

Indicates if the layer's query operation supports querying features or records related to features in the layer.

queryTopFeatures

Property
Type
QueryTopFeaturesCapabilities

Describes top features query operations that can be performed on features in the layer.

editing

Property
Type
EditingCapabilities

Describes editing capabilities that can be performed on the features in the layer via FeatureLayer.applyEdits().

VideoLayerCapabilities

Type definition

The capabilities of the VideoLayer. The capabilities describe the operations the video layer supports and are defined by the video service.

operations

Property
Type
VideoLayerCapabilitiesOperations

The operations capabilities of the video layer.

VideoLayerCapabilitiesOperations

Type definition

Describes the video layer's supported capabilities.

supportsAppend

Property
Type
boolean

Indicates if the video layer supports appending data.

supportsCoverageQuery

Property
Type
boolean

Indicates if the video layer supports coverage queries.

supportsExportClip

Property
Type
boolean

Indicates if the video layer supports exporting clips.

supportsExportFrameset

Property
Type
boolean

Indicates if the video layer supports exporting frames.

supportsMensuration

Property
Type
boolean

Indicates if the video layer supports mensuration.

supportsPreviews

Property
Type
boolean

Indicates if the video layer supports display of frame previews.

supportsUpdate

Property
Type
boolean

Indicates if the video layer supports updating data.

VectorTileLayerCapabilities

Type definition

Capabilities of the VectorTileLayer. The capabilities describe the operations the vector tile layer supports and are defined by the vector tile service.

operations

Property
Type
VectorTileLayerCapabilitiesOperations

Indicates operations that can be performed on the service.

exportTiles

Property
Type
VectorTileLayerCapabilitiesExportTiles | null | undefined

Indicates options supported by the exportTiles operation. Will be null if the supportsExportTiles is false.

VectorTileLayerCapabilitiesOperations

Type definition

Describes the VectorTileLayer's supported operations as part of its VectorTileLayerCapabilities.

supportsExportTiles

Property
Type
boolean

Indicates if the tiles from the service can be exported.

supportsTileMap

Property
Type
boolean

Indicates if the service exposes a tile map that describes the presence of tiles.

VectorTileLayerCapabilitiesExportTiles

Type definition

Describes the export tiles options supported by the VectorTileLayer as part of its VectorTileLayerCapabilities.

maxExportTilesCount

Property
Type
number

Specifies the maximum number of tiles that can be exported to a cache dataset or a tile package.

FetchImageOptions

Type definition

Options for fetching exported images from a map image service.

See also
Supertypes
AbortOptions

rotation

Property
Type
number | null | undefined

The rotation in degrees of the exported image. Available since ArcGIS Server 10.3.

pixelRatio

Property
Type
number | null | undefined

The ratio of the resolution in physical pixels of the image to the resolution it will be displayed at.

timeExtent

Property
Type
TimeExtent | null | undefined

The time instant or time extent of content to render.

SceneLayerCapabilities

Type definition

Describes the layer's supported capabilities.

query

Property
Type
FeatureLayerCapabilities["query"]

Describes Query operations that can be performed on features in the layer.

queryRelated

Property
Type
FeatureLayerCapabilities["queryRelated"]

Indicates if the layer's query operation supports querying features or records related to features in the layer.

data

Property
Type
SceneLayerCapabilitiesData

Describes characteristics of the data in the layer.

operations

Property
Type
SceneLayerCapabilitiesOperations

Describes operations that can be performed on features in the layer.

editing

Property
Type
SceneLayerCapabilitiesEditing

Describes editing capabilities that can be performed on the features in the layer via SceneLayer.applyEdits().

SceneLayerCapabilitiesData

Type definition

Subset of FeatureLayer data capabilities exposed for SceneLayers.

Supertypes
Pick<FeatureLayerCapabilities["data"]‚ "supportsZ" | "supportsM" | "isVersioned" | "supportsAttachment">

SceneLayerCapabilitiesEditing

Type definition

Subset of FeatureLayer editing capabilities exposed for SceneLayers.

Supertypes
Pick<FeatureLayerCapabilities["editing"]‚ "supportsGlobalId" | "supportsGeometryUpdate" | "supportsRollbackOnFailure" | "supportsUploadWithItemId">

SceneLayerCapabilitiesOperations

Type definition

Subset of FeatureLayer operation capabilities exposed for SceneLayers.

Supertypes
Pick<FeatureLayerCapabilities["operations"]‚ "supportsQuery" | "supportsQueryAttachments" | "supportsAdd" | "supportsDelete" | "supportsEditing" | "supportsUpdate">

RouteLayerSolveResult

Type definition

The results of computing a route and directions.

directionLines

Property
Type
Collection<DirectionLine>

Collection of direction polylines associated with line segments between turns.

directionPoints

Property
Type
Collection<DirectionPoint>

Collection of direction items as points with various display information.

pointBarriers

Property
Type
Collection<PointBarrier>

Point barrier(s) to restrict travel along a street network when using a RouteLayer.

polygonBarriers

Property
Type
Collection<PolygonBarrier>

Polygon barrier(s) to restrict travel along a street network when using a RouteLayer.

polylineBarriers

Property
Type
Collection<PolylineBarrier>

Polyline barrier(s) to restrict travel along a street network when using a RouteLayer.

routeInfo

Property
Type
RouteInfo

Information about a solved route including the route's geometry and overall distance and time.

stops

Property
Type
Collection<Stop>

Represents the start, end, or midpoint of a route created using the RouteLayer.

BlendMode

Type definition

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. Blend modes can create a variety of very vibrant and intriguing results by blending a layer with the layer(s) below it.

See also
Type
"average" | "color-burn" | "color-dodge" | "color" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | "hard-light" | "hue" | "invert" | "lighten" | "lighter" | "luminosity" | "minus" | "multiply" | "normal" | "overlay" | "plus" | "reflect" | "saturation" | "screen" | "soft-light" | "source-atop" | "source-in" | "source-out" | "vivid-light" | "xor"

ElevationLayerUnion

Type definition

Union of supported ground elevation layer types.

LayerSaveOptions

Type definition

Options for saving a layer as a portal item.

ignoreUnsupported

Property
Type
boolean | undefined

Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology.

LayerSaveAsOptions

Type definition

Options for saving a layer as a new portal item.

Supertypes
LayerSaveOptions

folder

Property
Type
PortalFolder | undefined

The portal folder where the layer's portal item will be saved.

ScaleRange

Type definition

Describes a scale range with a minimum and maximum scale.

See also

minScale

Property
Type
number

The minimum scale at a given range.

maxScale

Property
Type
number

The maximum scale at a given range.

FieldDomainOptions

Type definition

feature

Property
Type
Graphic | undefined

The feature to which the Domain is assigned.

FeatureTitleOptions

Type definition

Options for generating a feature title.

See also

timeZone

Property
Type
TimeZone | null | undefined

The time zone to use when formatting date fields in the title. If null, the default time zone is used.

fetchMissingFields

Property
Type
boolean | undefined

Indicates whether to fetch missing fields from the service if they are not already present in the graphic.

Default value
false