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: DynamicLayerInfo
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/DynamicLayerInfo"], function(DynamicLayerInfo) { /* code goes here */ });
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
| Name | Summary |
|---|---|
| new DynamicLayerInfo(json?) | Creates a new DynamicLayerInfo object. |
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. |
| 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
| Name | Return type | Summary |
|---|---|---|
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new DynamicLayerInfo object.
Parameters:
< |
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
<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.
Sample:
dynamicLayerInfo.id = 0;
<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.
Sample:
dynamicLayerInfo.maxScale = 1000000; dynamicLayerInfo.minScale = 0;
<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.
Sample:
dynamicLayerInfo.maxScale = 1000000; dynamicLayerInfo.minScale = 0;
<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.
<LayerSource
LayerSourceThe source for the dynamic layer can be either a LayerMapSource or LayerDataSource. Requires ArcGIS Server 10.1 service.
Sample:
require([
"esri/layers/DynamicLayerInfo", "esri/layers/TableDataSource", ...
], function(DynamicLayerInfo, TableDataSource, ... ) {
var dataSource = new TableDataSource();
dataSource.workspaceId = "d203";
dataSource.dataSourceName = "sde.SDE.states";
var dynamicLayerInfo = new DynamicLayerInfo( ... );
var layerSource = new LayerDataSource();
layerSource.dataSource = dataSource;
dynamicLayerInfo.source = layerSource;
...
});
<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.
Method Details