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

Referenced by: baseMapLayer, operationalLayers

Properties

PropertyDetails
customParametersA sequence of custom parameters appended to the URL of all requests related to a layer.
idA unique identifying string for the layer.
isReferenceThis 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).
itemIdOptional 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.
layerTypeString indicating the layer type.
Valid value of this property ArcGISMapServiceLayer
listModeTo 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
maxScaleA number representing the maximum scale at which the layer will be visible. The number is the scale’s denominator.
minScaleA number representing the minimum scale at which the layer will be visible. The number is the scale’s denominator.
opacityThe degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
refreshIntervalRefresh 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.
showLegendBoolean value indicating whether to display the layer in the legend. Default value is true.
timeAnimationIndicates whether to enable time animation if the layer supports it. Default value is true.
titleA user-friendly string title for the layer that can be used in a table of contents.
urlThe URL to the layer.
visibilityBoolean property determining whether the layer is initially visible in the web scene.
visibilityTimeExtentRepresents time extent that will control when a layer should be visible based on webscene’s current time. Visibility time extent only affects the layer visibility and will not filter the data.
visibleLayers[]An array of sublayer ids that should appear visible. Used with map service layers that are not tiled.

layers properties

PropertyDetails
defaultVisibilityDefault visibility of the layers in the map service.
disablePopupIndicates whether to allow a client to ignore the popups defined on the layer. The popupInfo object could be saved in the map or item.
idThe layer id, as a numeric value.
layerDefinitionAdditional properties that define drawing information and other configurations for the layer.
listModeTo 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
maxScaleA number representing the maximum scale at which the layer will be visible. The number is the scale’s denominator.
minScaleA number representing the minimum scale at which the layer will be visible. The number is the scale’s denominator.
nameThe name of the layer.
parentLayerIdIf working with nested layers, this is the numeric value indicating the layer id of the next layer (parent) directly above the current referenced layer.
popupInfoA popupInfo object defining the popup window content for the layer.
showLegendA 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"
}