Package | com.google.maps.overlays |
Class | public class GroundOverlay |
Implements | flash.events.IEventDispatcher, IGroundOverlay |
Property | Defined by | ||
---|---|---|---|
foreground : DisplayObject [read-only]
Display object that represents the overlay's content.
| GroundOverlay | ||
pane : IPane
Pane this overlay resides on (null if the overlay is not added to the map).
| GroundOverlay | ||
shadow : DisplayObject [read-only]
Display object that represents the overlay's shadow (null if the overlay
never has a shadow).
| GroundOverlay | ||
visible : Boolean
Visibility of the overlay.
| GroundOverlay |
Method | Defined by | ||
---|---|---|---|
Constructs a new GroundOverlay instance, using the specified options.
| GroundOverlay | ||
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).
| GroundOverlay | ||
Retrieves the full set of options used by the ground overlay.
| GroundOverlay | ||
positionOverlay(zoomChanged:Boolean):void
Reposition the overlay on the screen.
| GroundOverlay | ||
setOptions(options:GroundOverlayOptions):void
Updates the ground overlay options.
| GroundOverlay |
Method | Defined by | ||
---|---|---|---|
clearWrapper():void
Remove all event listeners and clear the wrapper.
| GroundOverlay |
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
GroundOverlay | () | constructor |
public function GroundOverlay(content:DisplayObject, bounds:LatLngBounds, options:GroundOverlayOptions = null)
Constructs a new GroundOverlay instance, using the specified options.
Parameterscontent:DisplayObject — Content to display.
|
|
bounds:LatLngBounds — Latitude and longitude bounds over which the image extends.
|
|
options:GroundOverlayOptions (default = null ) — Ground overlay options.
|
See also
clearWrapper | () | method |
protected function clearWrapper():void
Remove all event listeners and clear the wrapper.
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.
|
getOptions | () | method |
public function getOptions():GroundOverlayOptions
Retrieves the full set of options used by the ground overlay. Use the setOptions method to modify the options on the ground overlay.
ReturnsGroundOverlayOptions —
Options used by the ground overlay.
|
See also
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.
|
setOptions | () | method |
public function setOptions(options:GroundOverlayOptions):void
Updates the ground overlay options.
The options
parameter may specify a complete or partial set
of ground overlay options. If a partial set of options is specified, it
will supplement the existing marker options, overriding only the values
that were set explicitly and leaving the rest unchanged.
options:GroundOverlayOptions — New full or partial set of options for the ground overlay.
|
var options:GroundOverlayOptions = new GroundOverlayOptions( { strokeStyle: { color: 0x000080 }} ); myGroundOverlay.setOptions(options);