Package | com.google.maps.interfaces |
Interface | public interface IOverlay extends IWrappableEventDispatcher, flash.events.IEventDispatcher, IWrappable |
Subinterfaces | IGroundOverlay, IInfoWindow, IMarker, IPolygon, IPolyline, ITileLayerOverlay |
Implementors | OverlayBase |
Property | Defined by | ||
---|---|---|---|
foreground : DisplayObject [read-only]
Display object that represents the overlay's content.
| IOverlay | ||
![]() | interfaceChain : Array
List of interfaces for wrapping this object.
| IWrappable | |
pane : IPane
Pane this overlay resides on (null if the overlay is not added to the map).
| IOverlay | ||
shadow : DisplayObject [read-only]
Display object that represents the overlay's shadow (null if the overlay
never has a shadow).
| IOverlay | ||
visible : Boolean
Visibility of the overlay.
| IOverlay | ||
![]() | wrapper : Object
Instance of the cross-domain wrapper for this object.
| IWrappable |
Method | Defined by | ||
---|---|---|---|
![]() |
getBaseEventDispatcher():Object
Retrieves the base event dispatcher object that allows access to event
dispatching capability for cross-domain objects.
| IWrappableEventDispatcher | |
Retrieves the default pane that this overlay should be placed on
if none is explicitly specified (when the overlay is added through the
IMap.addOverlay() call).
| IOverlay | ||
positionOverlay(zoomChanged:Boolean):void
Reposition the overlay on the screen.
| IOverlay |
foreground | property |
foreground:DisplayObject
[read-only]Display object that represents the overlay's content.
Implementation public function get foreground():DisplayObject
pane | property |
pane:IPane
[read-write]Pane this overlay resides on (null if the overlay is not added to the map). This property value is set by the map when the overlay is added to or removed from the map and should not be modified by the developers.
Implementation public function get pane():IPane
public function set pane(value:IPane):void
shadow | property |
shadow:DisplayObject
[read-only]Display object that represents the overlay's shadow (null if the overlay never has a shadow).
Implementation public function get shadow():DisplayObject
visible | property |
visible:Boolean
[read-write]Visibility of the overlay.
Implementation public function get visible():Boolean
public function set visible(value:Boolean):void
getDefaultPane | () | method |
public function getDefaultPane(map:IMap):IPane
Retrieves the default pane that this overlay should be placed on if none is explicitly specified (when the overlay is added through the IMap.addOverlay() call).
Parametersmap:IMap — Instance of map that this overlay is added to.
|
IPane —
Instance of IPane to which the overlay will be added by default.
|
positionOverlay | () | method |
public function positionOverlay(zoomChanged:Boolean):void
Reposition the overlay on the screen. This method is called in response to changes in the position (centre) of the map and/or the map's zoom level. Developers should not call the method themselves. The implementation of this method should either change the position of the overlay on the screen in response to the change of the map's centre or redraw the overlay completely if it needs to be reconfigured for a different map centre/zoom level. Repositioning of the overlay should be done by changing the placement of the overlay's display object on its pane using the mappings provided by the IPane interface (fromLatLngToPaneCoords or fromProjectionPointToPaneCoords).
ParameterszoomChanged:Boolean — Whether the zoom level of the map has changed
or the call was invoked just as a result of a map pan.
|