dojo.require("esri.layers.DynamicLayerInfo")
Description
(Added at v2.7)
Information about each layer in a map service. This class extends the
LayerInfo
class with a new property source which can be either a
LayerMapSource
or a
LayerDataSource
.
See also
Samples
Search for
samples that use this class.
Class hierarchy
esri/layers.LayerInfo
|_esri/layers.DynamicLayerInfo
Constructors
Properties
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. |
source | LayerSource | The source for the dynamic layer can be either a LayerMapSource or LayerDataSource. |
subLayerIds | Number[] | If the layer is a parent layer, it will have one or more sub layers included in an array. |
Methods
toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new DynamicLayerInfo object.
Parameters:
<Object > json |
Optional |
JSON object representing the DynamicLayerInfo.
require([
"esri/layers/DynamicLayerInfo", ...
], function(DynamicLayerInfo, ... ) {
var dynamicLayerInfo = new DynamicLayerInfo({
"defaultVisibility": true,
"id": 0,
"maxScale": 1000000,
"minScale": 0,
"parentLayerId": -1
});
...
});
|
Property Details
Default visibility of the layers in the map service.
Known values: true | false
Layer 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.
Sample:
dynamicLayerInfo.id = 0;
The 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.
Sample:
dynamicLayerInfo.maxScale = 1000000;
dynamicLayerInfo.minScale = 0;
The 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.
Sample:
dynamicLayerInfo.maxScale = 1000000;
dynamicLayerInfo.minScale = 0;
Layer name as defined in the map service.
If 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.
The source for the dynamic layer can be either a LayerMapSource or LayerDataSource. Requires ArcGIS Server 10.1 service.
Sample:
var dataSource = new esri.layers.TableDataSource();
dataSource.workspaceId = "d203";
dataSource.dataSourceName = "sde.SDE.states";
var layerSource = new esri.layers.LayerDataSource();
layerSource.dataSource = dataSource;
dynamicLayerInfo.source = layerSource;
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.
Method Details
Converts object to its ArcGIS Server JSON representation.