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
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
Indicates how the layer should display in the Layer List component. The possible values are listed below.
| Value | Description |
|---|---|
| show | The layer is visible in the table of contents. |
| hide | The layer is hidden in the table of contents. |
| hide-children | If 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
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
EditingInfo
- Since
- ArcGIS Maps SDK for JavaScript 4.12
Specifies information about editing.
SupportedSpatialAggregationStatistics
Indicates which spatial aggregation statistic geometries are supported.
envelope
- Type
- boolean
Indicates if the layer can return extent for each distinct group for Query.groupByFieldsForStatistics.
centroid
- Type
- boolean
Indicates if the layer can return centroid for each distinct group for Query.groupByFieldsForStatistics.
convexHull
- Type
- boolean
Indicates if the layer can return convex hull for each distinct group for Query.groupByFieldsForStatistics.
SupportedBinStatistics
Indicates which statistics are supported for attribute binning queries.
- See also
- Supertypes
- SupportedSpatialAggregationStatistics
SupportedBinNormalizationTypes
Indicates which normalization types are supported for attribute binning queries.
DataCapabilities
Describes characteristics of the data in the layer as part of its FeatureLayerCapabilities.
- See also
supportsTrueCurve
- Type
- boolean
Indicates if the layer supports geometries with true curves.
supportsZ
- 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
Describes the metadata contained on features in the layer as part of its FeatureLayerCapabilities.
supportsAdvancedFieldProperties
- Type
- boolean
Indicates whether to provide a user-defined field description. See Describe attribute fields for additional information.
OperationCapabilities
Describes operations that can be performed on features in the layer as part of its FeatureLayerCapabilities.
supportsCalculate
- 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.
supportsQueryAttachments
- 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
- Type
- boolean
Indicates if the layer supports REST API queryTopFeatures operation.
supportsValidateSql
- Type
- boolean
Indicates if the layer supports a SQL-92 expression or where clause.
QueryCapabilities
Describes Query operations that can be performed on features in the layer.
supportedSpatialAggregationStatistics
List of supported aggregated geometries returned for each distinct group when Query.groupByFieldsForStatistics is used.
supportsCacheHint
- Type
- boolean
Indicates if the query operation supports a cache hint. This is valid only for hosted feature services.
supportsCentroid
- 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
- Type
- boolean
Indicates if the query operation supports disjoint spatial relationship. This is valid only for
hosted feature services.
supportsDistance
- Type
- boolean
Indicates if the layer's query operation supports a buffer distance for input geometries.
supportsDistinct
- Type
- boolean
Indicates if the layer supports queries for distinct values based on fields specified in the FeatureLayer.outFields.
supportsExtent
- 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
- 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
- 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
- Type
- boolean
Indicates if the layer supports historic moment query. Requires ArcGIS Server service 10.5 or greater.
supportsMaxRecordCountFactor
- Type
- boolean
Indicates if the layer supports Query.maxRecordCountFactor on the service.
supportsOrderBy
- 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
- Type
- boolean
Indicates if the query response supports pagination. Requires an ArcGIS Server service 10.3 or greater.
supportsPercentileStatistics
- Type
- boolean
Indicates if the layer supports percentile statisticType. Requires an ArcGIS Server service 10.7 or greater.
supportsQuantization
- 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
- 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
- Type
- boolean
Indicates if the query response includes the query geometry. This is valid only for hosted feature services.
supportsResultType
- Type
- boolean
Indicates if the number of features returned by the query operation can be controlled.
supportsSpatialAggregationStatistics
- 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
- Type
- boolean
Indicates if the query operation supports SQL expressions.
supportsStandardizedQueriesOnly
- Type
- boolean
Indicates if the query operation supports using standardized queries. Learn more about standardized queries here.
supportsStatistics
- Type
- boolean
Indicates if the layer supports field-based statistical functions. Requires ArcGIS Server service 10.1 or greater.
supportsTrueCurve
- Type
- boolean
Indicates if the layer supports geometries with true curves.
QueryRelatedCapabilities
Indicates if the layer's query operation supports querying features or records related to features in the layer.
supportsCacheHint
- Type
- boolean
Indicates if the relationship query operation supports a cache hint. This is valid only for hosted feature services.
supportsCount
- Type
- boolean
Indicates if the layer's query response includes the number of features or records related to features in the layer.
supportsOrderBy
- Type
- boolean
Indicates if the related features or records returned in the query response can be ordered by one or more fields.
supportsPagination
- Type
- boolean
Indicates if the query response supports pagination for related features or records.
EditingCapabilities
Describes editing capabilities that can be performed on the features in the layer via applyEdits().
supportsDeleteByAnonymous
- Type
- boolean
Indicates if anonymous users can delete features created by others.
supportsDeleteByOthers
- Type
- boolean
Indicates if logged in users can delete features created by others.
supportsGeometryUpdate
- Type
- boolean
Indicates if the geometry of the features in the layer can be edited.
supportsGlobalId
- Type
- boolean
Indicates if the globalId values provided by the client are used in FeatureLayer.applyEdits().
supportsRollbackOnFailure
- Type
- boolean
Indicates if the rollbackOnFailureEnabled parameter can be set to true or false when editing features.
supportsTrueCurveUpdate
- Type
- boolean
Indicates if feature geometries containing true curves can be updated.
supportsTrueCurveUpdateByTrueCurveClientsOnly
- 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
- Type
- boolean
Indicates if anonymous users can update features created by others.
supportsUpdateByOthers
- Type
- boolean
Indicates if logged in users can update features created by others.
supportsUpdateWithoutM
- Type
- boolean
Indicates if m-values must be provided when updating features.
AttachmentCapabilities
Describes what attachment capabilities are enabled on the layer as part of its FeatureLayerCapabilities.
supportsCacheHint
- Type
- boolean
Indicates if the attachment operations support a cache hint. This is valid only for hosted feature services.
supportsResize
- 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.
AnalyticsCapabilities
Describes what analytics capabilities are enabled on the layer as part of its FeatureLayerCapabilities.
QueryTopFeaturesCapabilities
Describes top features query operations that can be performed on features in the layer as part of its FeatureLayerCapabilities.
supportsCacheHint
- Type
- boolean
Indicates if the top query operation supports a cache hint. This is valid only for hosted feature services.
QueryBinsCapabilities
Describes AttributeBinsQuery operations that can be performed on features in the layer.
supportsDate
- Type
- boolean
Indicates if the layer supports date field-based attribute bins query functions.
supportsFixedInterval
- Type
- boolean
Indicates if the layer supports fixed interval attribute bins query functions.
supportsAutoInterval
- Type
- boolean
Indicates if the layer supports auto interval attribute bins query functions.
supportsFixedBoundaries
- Type
- boolean
Indicates if the layer supports fixed boundaries attribute bins query functions.
supportsStackBy
- Type
- boolean
Indicates if the layer supports the stackBy parameter in attribute bins query functions.
supportsSplitBy
- Type
- boolean
Indicates if the layer supports the splitBy parameter in attribute bins query functions.
supportsSnapToData
- Type
- boolean
Indicates if the layer's date field-based binning supports snapping data to either the first or last date point.
supportsReturnFullIntervalBin
- 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
- Type
- boolean
Indicates if the first day of the week can be set for date binning.
supportedStatistics
- Type
- SupportedBinStatistics | null | undefined
Indicates if the layer supports statistics attribute bins query functions.
supportedNormalizationTypes
- Type
- SupportedBinNormalizationTypes | null | undefined
Normalization types supported by the queryBins operation.
FeatureLayerCapabilities
Describes the layer's supported capabilities.
attachment
- Type
- AttachmentCapabilities | null | undefined
Describes what attachment capabilities are enabled on the layer.
metadata
- Type
- MetadataCapabilities
Describes the metadata contained on features in the layer.
query
- Type
- QueryCapabilities
Describes Query operations that can be performed on features in the layer.
queryAttributeBins
Describes AttributeBinsQuery operations that can be performed on features in the layer.
queryTopFeatures
Describes top features query operations that can be performed on features in the layer.
editing
- Type
- EditingCapabilities
Describes editing capabilities that can be performed on the features in the layer via FeatureLayer.applyEdits().
VideoLayerCapabilities
The capabilities of the VideoLayer. The capabilities describe the operations the video layer supports and are defined by the video service.
VideoLayerCapabilitiesOperations
Describes the video layer's supported capabilities.
supportsExportFrameset
- Type
- boolean
Indicates if the video layer supports exporting frames.
supportsPreviews
- Type
- boolean
Indicates if the video layer supports display of frame previews.
VectorTileLayerCapabilities
Capabilities of the VectorTileLayer. The capabilities describe the operations the vector tile layer supports and are defined by the vector tile service.
VectorTileLayerCapabilitiesOperations
Describes the VectorTileLayer's supported operations as part of its VectorTileLayerCapabilities.
supportsTileMap
- Type
- boolean
Indicates if the service exposes a tile map that describes the presence of tiles.
VectorTileLayerCapabilitiesExportTiles
Describes the export tiles options supported by the VectorTileLayer as part of its VectorTileLayerCapabilities.
maxExportTilesCount
- Type
- number
Specifies the maximum number of tiles that can be exported to a cache dataset or a tile package.
FetchImageOptions
Options for fetching exported images from a map image service.
- See also
- Supertypes
- AbortOptions
timeExtent
- Type
- TimeExtent | null | undefined
The time instant or time extent of content to render.
SceneLayerCapabilities
Describes the layer's supported capabilities.
query
- Type
- FeatureLayerCapabilities["query"]
Describes Query operations that can be performed on features in the layer.
queryRelated
- Type
- FeatureLayerCapabilities["queryRelated"]
Indicates if the layer's query operation supports querying features or records related to features in the layer.
editing
Describes editing capabilities that can be performed on the features in the layer via SceneLayer.applyEdits().
SceneLayerCapabilitiesData
Subset of FeatureLayer data capabilities exposed for SceneLayers.
- Supertypes
- Pick<FeatureLayerCapabilities["data"]‚ "supportsZ" | "supportsM" | "isVersioned" | "supportsAttachment">
SceneLayerCapabilitiesEditing
Subset of FeatureLayer editing capabilities exposed for SceneLayers.
- Supertypes
- Pick<FeatureLayerCapabilities["editing"]‚ "supportsGlobalId" | "supportsGeometryUpdate" | "supportsRollbackOnFailure" | "supportsUploadWithItemId">
SceneLayerCapabilitiesOperations
Subset of FeatureLayer operation capabilities exposed for SceneLayers.
- Supertypes
- Pick<FeatureLayerCapabilities["operations"]‚ "supportsQuery" | "supportsQueryAttachments" | "supportsAdd" | "supportsDelete" | "supportsEditing" | "supportsUpdate">
RouteLayerSolveResult
The results of computing a route and directions.
directionLines
- Type
- Collection<DirectionLine>
Collection of direction polylines associated with line segments between turns.
directionPoints
- Type
- Collection<DirectionPoint>
Collection of direction items as points with various display information.
pointBarriers
- Type
- Collection<PointBarrier>
Point barrier(s) to restrict travel along a street network when using a RouteLayer.
polygonBarriers
- Type
- Collection<PolygonBarrier>
Polygon barrier(s) to restrict travel along a street network when using a RouteLayer.
polylineBarriers
- Type
- Collection<PolylineBarrier>
Polyline barrier(s) to restrict travel along a street network when using a RouteLayer.
routeInfo
- Type
- RouteInfo
Information about a solved route including the route's geometry and overall distance and time.
stops
- Type
- Collection<Stop>
Represents the start, end, or midpoint of a route created using the RouteLayer.
BlendMode
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
Union of supported ground elevation layer types.
- Type
- ElevationLayer | BaseElevationLayer
LayerSaveAsOptions
Options for saving a layer as a new portal item.
- Supertypes
- LayerSaveOptions
folder
- Type
- PortalFolder | undefined
The portal folder where the layer's portal item will be saved.