Map Service Layer (ArcGISMapServiceLayer)

Map services can be cached (tiled) or uncached (dynamic). This object specifically details properties within uncached map services.

Referenced by: baseMapLayer, operationalLayers

Properties

Property Details
customParameters A sequence of custom parameters appended to the URL of all requests related to supporting ArcGIS layer types.
id A unique identifying string for the layer.
isReference This is applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers, or below (false).
itemId Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.
layers An array of layer objects defining the styling, geometry, and attribute information for the features.
See layers properties table.
layerType String indicating the layer type.
Valid value of this property ArcGISMapServiceLayer
listMode To show or hide the sublayer in the layer list. If the layer has sublayers, selecting hide-children will hide them in the layer list.
Valid values:
  • hide
  • hide-children
  • show
maxScale A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
minScale A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
opacity The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshInterval Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.
showLegend Boolean value indicating whether to display the layer in the legend. Default value is true.
title A user-friendly string title for the layer that can be used in a table of contents.
url The URL to the layer.
visibility Boolean property determining whether the layer is initially visible in the web scene.
visibleLayers An array of sublayer ids that should appear visible. Used with map service layers that are not tiled.

layers properties

Property Details
defaultVisibility Default visibility of the layers in the map service.
disablePopup Indicates whether to allow a client to ignore the popups defined on the layer. The popupInfo object could be saved in the map or item.
id The layer id, as a numeric value.
layerDefinition Additional properties that define drawing information and other configurations for the layer.
listMode To show or hide the sublayer in the layer list. If the layer has sublayers, selecting hide-children will hide them in the layer list.
Valid values:
  • hide
  • hide-children
  • show
maxScale A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
minScale A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
name The name of the layer.
parentLayerId If working with nested layers, this is the numeric value indicating the layer id of the next layer (parent) directly above the current referenced layer.
popupInfo A popupInfo object defining the popup window content for the layer.
showLegend A Boolean indicating if the layer should be shown in the legend in client applications.
subLayerIds If the layer is a parent layer, it will have one or more sub layers included in an array.

operationalLayer Example

Live sample web scene showing the ArcGISMapServiceLayer as an operationalLayer

{
  "id": "15988a24a0e-layer-2",
  "layerType": "ArcGISMapServiceLayer",
  "url": "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer",
  "visibility": true,
  "opacity": 1,
  "title": "Census"
}

baseMapLayer Example

{
  "id": "defaultBasemap",
  "layerType": "ArcGISMapServiceLayer",
  "url": "https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer",
  "visibility": true,
  "opacity": 1,
  "title": "Topographic"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.