| Package | com.yahoo.maps.api.managers |
| Class | public class OverlayManager |
| Property | Defined by | ||
|---|---|---|---|
| overlayContainer : Sprite [read-only]
Returns the container in which overlays are shown on.
| OverlayManager | ||
| overlays : Array [read-only]
An Array of the overlays currently active on the map.
| OverlayManager | ||
| Method | Defined by | ||
|---|---|---|---|
|
OverlayManager(container:Sprite, map:IYahooMap)
Creates a new OverlayManager object.
| OverlayManager | ||
|
addOverlay(overlay:Overlay):void
Adds an overlay onto the overlayContainer.
| OverlayManager | ||
|
destroy():void
Prepares this object for garbage-collection.
| OverlayManager | ||
|
getOverlaysOnStage():Array
Returns an array of overlays currently added to the stage.
| OverlayManager | ||
|
getVisibleOverlays():Array
Returns an array of overlays that are visible on the stage.
| OverlayManager | ||
|
removeAllOverlays():void
Removes all overlays from the overlayContainer.
| OverlayManager | ||
|
removeOverlay(overlay:Overlay):void
Removes an overlay from the overlayContainer.
| OverlayManager | ||
| overlayContainer | property |
overlayContainer:Sprite [read-only]Returns the container in which overlays are shown on.
Implementation public function get overlayContainer():Sprite
| overlays | property |
overlays:Array [read-only]An Array of the overlays currently active on the map.
Implementation public function get overlays():Array
| OverlayManager | () | constructor |
public function OverlayManager(container:Sprite, map:IYahooMap)Creates a new OverlayManager object.
Parameterscontainer:Sprite |
|
map:IYahooMap |
| addOverlay | () | method |
public function addOverlay(overlay:Overlay):voidAdds an overlay onto the overlayContainer.
Parametersoverlay:Overlay |
| destroy | () | method |
public function destroy():voidPrepares this object for garbage-collection.
| getOverlaysOnStage | () | method |
public function getOverlaysOnStage():ArrayReturns an array of overlays currently added to the stage.
ReturnsArray |
| getVisibleOverlays | () | method |
public function getVisibleOverlays():ArrayReturns an array of overlays that are visible on the stage.
ReturnsArray |
| removeAllOverlays | () | method |
public function removeAllOverlays():voidRemoves all overlays from the overlayContainer.
| removeOverlay | () | method |
public function removeOverlay(overlay:Overlay):voidRemoves an overlay from the overlayContainer.
Parametersoverlay:Overlay |