Packagecom.esri.aws.awx.map.layers
Classpublic class GroupLayer
InheritanceGroupLayer Inheritance com.esri.aws.awx.map.layers.BaseGroupLayer
Implementscom.esri.aws.awx.map.effects.IEffectAware

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

Default MXML Propertylayers

See also

com.esri.aws.awx.events.GroupLayerEvent


Public Properties
 PropertyDefined by
  editable : Boolean
If true, the group layer is editable so all of the manipulation methods with throw an error.
GroupLayer
  layers : Array
The layers in this group layer.
GroupLayer
  numLayers : int
[write-only] The number of layers in the group.
GroupLayer
  supportedProjections : Array
[write-only] The array of supported projections for this groupLayer.
GroupLayer
Public Methods
 MethodDefined by
  
GroupLayer(style:IStyle = null)
Creates a new GroupLayer.
GroupLayer
  
addLayer(layer:ILayer):void
Adds a layer to the group layer.
GroupLayer
  
addLayerAt(layer:ILayer, index:int):void
Adds a layer at a specific index.
GroupLayer
  
Gets a layer based on its identifier.
GroupLayer
  
moveLayerAbove(layer1ID:String, layer2ID:String):void
Moves the first layer above the the second layer in the z-order.
GroupLayer
  
moveLayerBelow(layer1ID:String, layer2ID:String):void
Moves the first layer below the the second layer in the z-order.
GroupLayer
  
moveLayerToBottom(layerID:String):void
Moves the layer to the bottom of the z-order.
GroupLayer
  
moveLayerToTop(layerID:String):void
Moves the layer to the top of the z-order.
GroupLayer
  
Removes all the layers.
GroupLayer
  
removeLayer(layerID:String):void
Removes a layer.
GroupLayer
  
swapLayers(layer1ID:String, layer2ID:String):void
Swaps the z-order of two layers.
GroupLayer
Events
 EventSummaryDefined by
   Dispatched after a child has been added to a container.GroupLayer
   Dispatched before a child of a container is removed.GroupLayer
   Dispatched when a layer has been swapped or moved up or down.GroupLayer
Property detail
editableproperty
editable:Boolean  [read-write]

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

Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
layersproperty 
layers:Array  [read-write]

The layers in this group layer.

Implementation
    public function get layers():Array
    public function set layers(value:Array):void
numLayersproperty 
numLayers:int  [write-only]

The number of layers in the group.

Implementation
    public function set numLayers(value:int):void
supportedProjectionsproperty 
supportedProjections:Array  [write-only]

The array of supported projections for this groupLayer.

Implementation
    public function set supportedProjections(value:Array):void
Constructor detail
GroupLayer()constructor
public function GroupLayer(style:IStyle = null)

Creates a new GroupLayer.

Parameters
style:IStyle (default = null) — The default style of the layer (optional).
Method detail
addLayer()method
public override function addLayer(layer:ILayer):void

Adds a layer to the group layer.

Parameters
layer:ILayer — the layer to add.
addLayerAt()method 
public override 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 override function getLayer(layerID:String):ILayer

Gets a layer based on its identifier.

Parameters
layerID:String — the layer identifier.

Returns
ILayer
moveLayerAbove()method 
public override 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 override 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 override 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 override 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 override function removeAllLayers():void

Removes all the layers.

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

Removes a layer.

Parameters
layerID:String — the layer to remove.
swapLayers()method 
public override 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.
Event detail
childAddevent 
Event object type: mx.events.ChildExistenceChangedEvent

Dispatched after a child has been added to a container.

The childAdd event is dispatched when the addChild() or addChildAt() method is called. When a container is first created, the addChild() method is automatically called for each child component declared in the MXML file. The addChildAt() method is automatically called whenever a Repeater object adds or removes child objects. The application developer may also manually call these methods to add new children.

At the time when this event is sent, the child object has been initialized, but its width and height have not yet been calculated, and the child has not been drawn on the screen. If you want to be notified when the child has been fully initialized and rendered, then register as a listener for the child's creationComplete event.

childRemoveevent  
Event object type: mx.events.ChildExistenceChangedEvent

Dispatched before a child of a container is removed.

This event is delivered when any of the following methods are called: removeChild(), removeChildAt(), or removeAllChildren().

groupLayerChangeevent  
Event object type: com.esri.aws.awx.events.GroupLayerEvent
GroupLayerEvent.type property = com.esri.aws.awx.events.GroupLayerEvent.GROUPLAYER_CHANGE

Dispatched when a layer has been swapped or moved up or down. For example, after moveLayerAbove(), moveLayerToTop(), moveLayerBelow(), moveLayerToBottom(), or swapLayers().

A layer has been moved within a GroupLayer.