Options
All
  • Public
  • Public/Protected
  • All
Menu

A layer within a basemap.

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

Hierarchy

Index

Properties

Optional copyright

copyright: string

Copyright information for this layer

Optional fullExtent

fullExtent: Extent

The full extent to use for this layer

id

id: string

A unique identifying string for the layer.

Optional isReference

isReference: boolean

Determines whether the basemap layer appears on top of all operational layers (true) or beneath all operational layers (false). Typically, this value is set to true on reference layers such as road networks, labels, or boundaries. The default value is false.

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.

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 portalUrl

portalUrl: string

Used for bing maps baselayers

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 templateUrl

templateUrl: string

Not defined in the official spec, but used by AGOL for web tiled layers.

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

A special string identifier used when the basemap is from Bing Maps or OpenStreetMap. When this property is included, the url property is not required. One of the BaseMapType constants.

Optional url

url: string

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

Optional visibility

visibility: boolean

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