Packagecom.esri.aws.awx.map.layers
Interfacepublic interface IGroupLayer extends ILayer, flash.events.IEventDispatcher
SubinterfacesIMap

A group layer is a collection of layers that need to be manipulated as one entity.



Public Properties
 PropertyDefined by
 Inheritedalpha : Number
The transparency value of the layer.
ILayer
  editable : Boolean
[read-only] If true, the group layer is editable so all of the manipulation methods with throw an error.
IGroupLayer
 Inheritedicon : Class
The icon that represents this layer.
ILayer
 Inheritedid : String
The layer identifier.
ILayer
 Inheritedlabel : String
The label of the layer.
ILayer
  layers : Array
[read-only] The layers in this group layer.
IGroupLayer
 InheritedlayerStyle : IStyle
The style of the layer.
ILayer
 Inheritedmap : IMap
The reference to the parent map container.
ILayer
  numLayers : int
[read-only] The number of layers in the group.
IGroupLayer
 Inheritedstyle : IStyle
DEPRECATED
ILayer
 InheritedsupportedProjections : Array
The array of supported projections for this groupLayer.
ILayer
 Inheritedvisible : Boolean
If true, the layer is visible.
ILayer
Public Methods
 MethodDefined by
  
addLayer(layer:ILayer):void
Adds a layer to the group layer.
IGroupLayer
  
addLayerAt(layer:ILayer, index:int):void
Adds a layer at a specific index.
IGroupLayer
  
getLayer(layerID:String):ILayer
Gets a layer based on its identifier.
IGroupLayer
 Inherited
getUIComponent():UIComponent
The layer's UIComponent.
ILayer
  
moveLayerAbove(layer1ID:String, layer2ID:String):void
Moves the first layer above the the second layer in the z-order.
IGroupLayer
  
moveLayerBelow(layer1ID:String, layer2ID:String):void
Moves the first layer below the the second layer in the z-order.
IGroupLayer
  
moveLayerToBottom(layerID:String):void
Moves the layer to the bottom of the z-order.
IGroupLayer
  
moveLayerToTop(layerID:String):void
Moves the layer to the top of the z-order.
IGroupLayer
  
Removes all the layers.
IGroupLayer
  
removeLayer(layerID:String):void
Removes a layer.
IGroupLayer
  
swapLayers(layer1ID:String, layer2ID:String):void
Swaps the z-order of two layers.
IGroupLayer
Property detail
editableproperty
editable:Boolean  [read-only]

If true, the group layer is editable so all of the manipulation methods with throw an error.

Implementation
    public function get editable():Boolean
layersproperty 
layers:Array  [read-only]

The layers in this group layer.

Implementation
    public function get layers():Array
numLayersproperty 
numLayers:int  [read-only]

The number of layers in the group.

Implementation
    public function get numLayers():int
Method detail
addLayer()method
public function addLayer(layer:ILayer):void

Adds a layer to the group layer.

Parameters
layer:ILayer — the layer to add.
addLayerAt()method 
public function addLayerAt(layer:ILayer, index:int):void

Adds a layer at a specific index.

Parameters
layer:ILayer — the layer to add.
 
index:int — the index where to add the layer.
getLayer()method 
public function getLayer(layerID:String):ILayer

Gets a layer based on its identifier.

Parameters
layerID:String — the layer identifier.

Returns
ILayer
moveLayerAbove()method 
public function moveLayerAbove(layer1ID:String, layer2ID:String):void

Moves the first layer above the the second layer in the z-order.

Parameters
layer1ID:String — the layer to move.
 
layer2ID:String — the layer to be moved above.
moveLayerBelow()method 
public function moveLayerBelow(layer1ID:String, layer2ID:String):void

Moves the first layer below the the second layer in the z-order.

Parameters
layer1ID:String — the layer to move.
 
layer2ID:String — the layer to be moved below.
moveLayerToBottom()method 
public function moveLayerToBottom(layerID:String):void

Moves the layer to the bottom of the z-order.

Parameters
layerID:String — the layer to move.
moveLayerToTop()method 
public function moveLayerToTop(layerID:String):void

Moves the layer to the top of the z-order.

Parameters
layerID:String — the layer to move.
removeAllLayers()method 
public function removeAllLayers():void

Removes all the layers.

removeLayer()method 
public function removeLayer(layerID:String):void

Removes a layer.

Parameters
layerID:String — the layer to remove.
swapLayers()method 
public function swapLayers(layer1ID:String, layer2ID:String):void

Swaps the z-order of two layers.

Parameters
layer1ID:String — the first layer to swap.
 
layer2ID:String — the second layer to swap.