ArcGIS web maps are designed to work with web services hosted on ArcGIS Server and ArcGIS Online, in addition to other types of servers. 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 |
|---|---|
| blendMode | Blend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default.Valid values: average, color, color-burn, color-dodge, darken, destination-atop, destination-in, destination-out, destination-over, difference, exclusion, hard-light, hue, invert, lighten, lighter, luminosity, minus, multiply, normal, overlay, plus, reflect, saturation, screen, soft-light, source-atop, source-in, source-out, vivid-light, xor |
| customParameters | A sequence of custom parameters appended to the URL of all requests related to a layer. |
| effect | Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work. |
| 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 |
| 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. |
| thematicGroup | (Optional) A thematicGroup object used in ArcGISMapServiceLayer layers. |
| timeAnimation | This property is applicable to layers that support time. If 'true', timeAnimation is enabled. |
| 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 map. |
| visibilityTimeExtent | Represents time extent that will control when a layer should be visible based on webmap'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
| Property | Details |
|---|---|
| attributeTableInfo | An attributeTableInfo object defining how the data will be presented in tabular format. |
| defaultVisibility | Default visibility of the layers in the map service. |
| definitionEditor | An object that provides interactive filters. |
| 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.definitionExpression | SQL-based definition expression string that narrows the data to be displayed in the layer. |
| layerDefinition.drawingInfo | Contains the drawing and labeling information. |
| layerDefinition.floorInfo | Contains floor-awareness information for the layer. |
| layerDefinition.orderBy[] | An array of orderByField objects specifying the feature display order. Features can be sorted in ascending or descending order of a numeric or date field only. If ascending, features with smaller values will be drawn on top of features with larger values. For date values, ascending order means features with older dates will be drawn on top of features with recent dates. If descending, the sort behavior is reversed. When this property is not defined, features are displayed in the order in which they are received by the client. |
| layerDefinition.source | An object indicating the layerDefinition's layer source. |
| 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 | Boolean value indicating whether to display the layer in the legend. Default value is true. |
| subLayerIds[] | If the layer is a parent layer, it will have one or more sub layers included in an array. |
Example
{
"id": "Census_6367",
"layerType": "ArcGISMapServiceLayer",
"url": "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer",
"visibility": true,
"opacity": 1,
"title": "Census",
"blendMode": "hue"
}Example
{
"id": "defaultBasemap",
"layerType": "ArcGISMapServiceLayer",
"url": "https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer",
"visibility": true,
"opacity": 1,
"title": "Topographic"
}