Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: LayerInfo
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/LayerInfo"], function(LayerInfo) { /* code goes here */ });
Description
(Added at v1.0)
Contains information about each layer in a map service. LayerInfo has no constructor.Samples
Search for samples that use this class.Subclasses
Properties
| Name | Type | Summary |
|---|---|---|
| defaultVisibility | Boolean | Default visibility of the layers in the map service. |
| id | Number | Layer ID assigned by ArcGIS Server for a layer. |
| maxScale | Number | The maximum visible scale for each layer in the map service. |
| minScale | Number | The minimum visible scale for each layer in the map service. |
| name | String | Layer name as defined in the map service. |
| parentLayerId | Number | If the layer is part of a group layer, it will include the parent ID of the group layer. |
| subLayerIds | Number[] | If the layer is a parent layer, it will have one or more sub layers included in an array. |
Property Details
<Boolean
BooleanDefault visibility of the layers in the map service.
Known values:
true | false<Number
NumberLayer ID assigned by ArcGIS Server for a layer. The topmost layer is 0, and each layer follows sequentially. If a layer is added or removed from the source map document, the ID values will shift accordingly.
<Number
NumberThe maximum visible scale for each layer in the map service. If the map is zoomed in beyond this scale the layer will not be visible. A value of 0 means that the layer does not have a maximum scale. This property is only available for map services published using ArcGIS Server 10 SP1 or later. (Added at v2.1)
<Number
NumberThe minimum visible scale for each layer in the map service. If the map is zoomed out beyond this scale the layer will not be visible. A value of 0 means that the layer does not have a minimum scale. This property is only available for map services published using ArcGIS Server 10 SP1 or later. (Added at v2.1)
<String
StringLayer name as defined in the map service.
<Number
NumberIf the layer is part of a group layer, it will include the parent ID of the group layer. Otherwise, the value is -1. If a layer is added or removed from the source map document, the ID values will shift accordingly.
<Number[]
Number[]If the layer is a parent layer, it will have one or more sub layers included in an array. Otherwise, the value is null. If a layer is added or removed from the source map document, the ID values will shift accordingly.