| Package | com.esri.aws.awx.map.layers |
| Class | public class OverlayLayer |
| Inheritance | OverlayLayer  com.esri.aws.awx.map.layers.BaseLayer |
| Subclasses | MarkerLayer, PolygonLayer, PolylineLayer |
| Property | Defined by | ||
|---|---|---|---|
| bringToTopOnMouseOver : Boolean = true
If true, on mouse over of an overlay object, the overlay display index is adjusted so
that it displays on the top of the stack.
| OverlayLayer | ||
| extent : Extent
[read-only]
The bounding box (maxX, maxY, minX, minY) of all the contained overlay objects.
| OverlayLayer | ||
| numOverlays : int [read-only]
The number of overlays currently in this layer.
| OverlayLayer | ||
| style : IStyle
The style is used by any overlays which inherit their style from its parent.
| OverlayLayer | ||
| Method | Defined by | ||
|---|---|---|---|
|
OverlayLayer(style:IStyle = null)
Creates a new OverlayLayer.
| OverlayLayer | ||
|
addOverlay(overlayObject:OverlayObject):void
Adds an overlay object to the layer.
| OverlayLayer | ||
|
getAllOverlays():Array
Gets all the overlay objects in the layer.
| OverlayLayer | ||
|
getOverlay(overlayName:String):OverlayObject
Gets an overlay object based on the overlay identifier.
| OverlayLayer | ||
|
removeAllOverlays():void
Removes all the overlay objects in the layer.
| OverlayLayer | ||
|
removeOverlay(overlayObject:OverlayObject):void
Removes an overlay object from the layer.
| OverlayLayer | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched after a child has been added to a container. | OverlayLayer | |||
| Dispatched before a child of a container is removed. | OverlayLayer | |||
| bringToTopOnMouseOver | property |
public var bringToTopOnMouseOver:Boolean = trueIf true, on mouse over of an overlay object, the overlay display index is adjusted so that it displays on the top of the stack.
| extent | property |
extent:Extent [read-only]The bounding box (maxX, maxY, minX, minY) of all the contained overlay objects. Returns an empty extent if there are no overlay objects in this layer.
Implementation public function get extent():Extent
See also
| numOverlays | property |
numOverlays:int [read-only]The number of overlays currently in this layer.
Implementation public function get numOverlays():int
| style | property |
style:IStyle [read-write]The style is used by any overlays which inherit their style from its parent.
Implementation public function get style():IStyle
public function set style(value:IStyle):void
| OverlayLayer | () | constructor |
public function OverlayLayer(style:IStyle = null)Creates a new OverlayLayer.
Parametersstyle:IStyle (default = null) |
| addOverlay | () | method |
public function addOverlay(overlayObject:OverlayObject):voidAdds an overlay object to the layer.
ParametersoverlayObject:OverlayObject — the overlay object to add to the layer.
|
| getAllOverlays | () | method |
public function getAllOverlays():ArrayGets all the overlay objects in the layer.
ReturnsArray — Array of OverlayObjects.
|
| getOverlay | () | method |
public function getOverlay(overlayName:String):OverlayObjectGets an overlay object based on the overlay identifier. Usually, this is the "name" property of the overlay object.
ParametersoverlayName:String — the overlay identifier.
|
OverlayObject —
The overlay object or null if not found.
|
| removeAllOverlays | () | method |
public function removeAllOverlays():voidRemoves all the overlay objects in the layer.
| removeOverlay | () | method |
public function removeOverlay(overlayObject:OverlayObject):voidRemoves an overlay object from the layer.
ParametersoverlayObject:OverlayObject — the overlay object to remove.
|
| childAdd | event |
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.
| childRemove | event |
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().