ArcGISMapService | References | ArcGIS Maps SDK for JavaScript

Types

import type { ArcGISMapService } from "@arcgis/core/layers/mixins/ArcGISMapService.js";

Subclasses:: MapImageLayer, TileLayer

Mixin for MapImageLayer and TileLayer.

Properties

Property	Type	Class
`capabilities` readonly	`MapServiceCapabilities`
`copyright`	`string \| null \| undefined`
`fullExtent`	`Extent \| null \| undefined`
`legendEnabled`	`boolean`
`spatialReference` readonly	`SpatialReference`
`version` readonly	`number`

capabilities

readonly Property

Type: MapServiceCapabilities

Since: ArcGIS Maps SDK for JavaScript 4.8

Indicates the layer's supported capabilities.

copyright

Property

Type: string | null | undefined

The copyright text as defined by the service.

fullExtent

autocast Property

Type: Extent | null | undefined

The full extent of the layer as defined by the map service.

Example

// zooms the view to the full extent of the layer
layer.when(function(){
  view.goTo(layer.fullExtent);
});

legendEnabled

Property

Type: boolean

Indicates whether the layer will be included in the legend.

Default value: true

spatialReference

readonly Property

Type: SpatialReference

The spatial reference of the layer as defined by the service.

version

readonly Property

Type: number

The version of ArcGIS Server in which the map service is published.

Example

// Prints the version number to the console - e.g. 10.91, 11.2, 11.3.
console.log(layer.version);

Type definitions

MapServiceCapabilities

Type definition

exportMap

Property

Type: MapServiceCapabilitiesExportMap | null | undefined

Indicates options supported by the exportMap operation. Will be null if the supportsExportMap is false.

exportTiles

Property

Type: MapServiceCapabilitiesExportTiles | null | undefined

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

operations

Property

Type: MapServiceCapabilitiesOperations

Indicates operations that can be performed on the service.

MapServiceCapabilitiesExportMap

Type definition

supportsArcadeExpressionForLabeling

Property

Type: boolean

Indicates if sublayers support Arcade expressions for labeling. Only applies to MapImageLayer.

supportsCIMSymbols

Property

Type: boolean

Indicates if CIMSymbol can be used in a sublayer's Sublayer.renderer.

supportsDynamicLayers

Property

Type: boolean

Indicates if sublayers rendering can be modified or added using dynamic layers.

supportsSublayersChanges

Property

Type: boolean

Indicates if sublayers can be added, or removed. supportsDynamicLayers must be true as well to be able to reorder sublayers.

supportsSublayerDefinitionExpression

Property

Type: boolean

Indicates if sublayers definition expression can be set.

supportsSublayerOrderBy

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.32

Indicates if sublayers can be reordered. supportsDynamicLayers must be true as well. Only applies to MapImageLayer.

supportsSublayerVisibility

Property

Type: boolean

Indicates if sublayers visibility can be changed.

MapServiceCapabilitiesExportTiles

Type definition

maxExportTilesCount

Property

Type: number

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

MapServiceCapabilitiesOperations

Type definition

supportsExportMap

Property

Type: boolean

Indicates if the service can generate images.

supportsExportTiles

Property

Type: boolean

Indicates if the tiles from the service can be exported.

supportsIdentify

Property

Type: boolean

Indicates if the service supports the identify operation.

supportsQuery

Property

Type: boolean

Indicates if features in the sublayers can be queried.

supportsTileMap

Property

Type: boolean

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