Options
All
  • Public
  • Public/Protected
  • All
Menu

A WMS web map layer.

Part of the Esri web map specification. See http://resources.arcgis.com/en/help/arcgis-web-map-json/.

Hierarchy

Index

Properties

Optional capabilities

capabilities: string

A comma-separated string listing which editing operations are allowed on an editable feature service. Available operations include: Create | Delete | Query | Update | Editing.

copyright

copyright: string

A string containing copyright and access information for a WMS layer. This is copied from the capabilities document exposed by the WMS.

extent

extent: Extent

The rectangular map extent that should be requested from the service, given in the format [[xmin, ymin],[xmax,ymax]].

Optional featureCollection

featureCollection: FeatureCollection

A featureCollection object defining a layer of features whose geometry and attributes will be stored directly within the web map. This is only used when no url property is supplied.

format

format: string

An optional string containing the image format to be requested from a WMS. The default is png, and this property only needs to be specified if a different image format will be requested, such as jpg.

Optional fullExtent

fullExtent: Extent

The full extent to use for this layer

id

id: string

A unique identifying string for the layer.

Optional itemId

itemId: string

Optional string containing the item ID of the service if it is registered on ArcGIS Online or your organization's portal. The web map applies any styling and pop-up information contained in the saved item.

Optional layerDefinition

layerDefinition: LayerDefinition

A LayerDefinition object defining the attribute schema and drawing information for the layer. Used with CSV and feature layers.

Optional layerType

layerType: string

Not in official spec, but present in some newer web maps.

Optional layers

layers: Layer[]

An array of Layer objects, allowing overrides on pop-up content and drawing behavior for the individual layers of a map service. Used with map services.

mapUrl

mapUrl: string

The URL of the WMS map. You should also supply the url property, which is the URL of the WMS capabilities document.

Optional maxHeight

maxHeight: number

A number defining the maximum height, in pixels, that should be requested from the service.

Optional maxScale

maxScale: number

A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.

Optional maxWidth

maxWidth: number

A number defining the maximum width, in pixels, that should be requested from the service.

Optional minScale

minScale: number

A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.

Optional mode

mode: number

Used with ArcGIS feature services and individual layers in ArcGIS map services, this property determines how the features are retrieved from the server. This property is represented as 0, 1, or 2.

0—Snapshot mode. Immediately retrieves all features when the map is loaded. 1—On-demand mode. Features within the current view extent are retrieved as the user navigates the map. This is the default and the most common way to use feature services in web maps. 2—Selection-only mode. No features are initially retrieved. This mode is used when you have a map service and a feature service from the same parent URL that are working together in the same map, with the map service being used for display and the feature service used for editing.

Optional opacity

opacity: number

The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.

Optional popupInfo

popupInfo: PopupInfo

A PopupInfo object defining the content of pop-up windows when you click or query a feature.

Optional showLabels

showLabels: boolean

Labels will display if this property is set to true and the layer also has a labelingInfo property associated with it.

spatialReferences

spatialReferences: [number]

An array of numbers containing well-known IDs for spatial references supported by the service.

Optional styleUrl

styleUrl: string

Vector Tiled layers have a style url, not a url

Optional subDomains

subDomains: string[]

Web tiled layers can have a list of subdomains used to make requests

Optional title

title: string

A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.

Optional type

type: string

If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type. One of the OperationalLayerType constants.

Optional url

url: string

The URL to the layer. For well-known basemap types such as Bing Aerial, the URL should be empty.

version

version: string

A string containing the version number of the service.

Optional visibility

visibility: boolean

Determines whether the layer is initially visible in the web map.

Optional visibleLayers

visibleLayers: any[]

An array of layers that should appear visible. Used with ArcGIS map services that are not tiled and WMS layers. Will be an array of numbers for ArcGIS map services, and an array of strings for WMS.