Packagecom.google.maps.interfaces
Interfacepublic interface IPane extends IWrappableEventDispatcher, flash.events.IEventDispatcher, IWrappable

IPane is the interface is implemented by the map panes. Pane is a container for overlays (such as markers, polylines, polygons etc).



Public Properties
 PropertyDefined by
  id : uint
[read-only] Pane's id.
IPane
 InheritedinterfaceChain : Array
List of interfaces for wrapping this object.
IWrappable
  map : IMap
[read-only] The instance of map this pane is added to.
IPane
  paneManager : IPaneManager
[read-only] The instance of pane manager this pane is added to.
IPane
  visible : Boolean
Visibility of the pane.
IPane
 Inheritedwrapper : Object
Instance of the cross-domain wrapper for this object.
IWrappable
Public Methods
 MethodDefined by
  
addOverlay(overlay:IOverlay):void
Adds an overlay to the pane.
IPane
  
bringToTop(overlay:IOverlay):void
Brings an overlay to the top of all other overlays on the pane.
IPane
  
clear():void
Removes all overlays added to this pane.
IPane
  
fromLatLngToPaneCoords(latLng:LatLng, closestToCenter:Boolean = false):Point
Translates the latLng to the pane's coordinate system.
IPane
  
fromPaneCoordsToLatLng(point:Point, opt_nowrap:Boolean = false):LatLng
Translates a point in the pane's coordinate system to lat/lng.
IPane
  
Converts a point in the pane's coordinate system to projection point coordinates for the current zoom level of the map.
IPane
  
fromProjectionPointToPaneCoords(projectionPoint:Point):Point
Converts projection point coordinates to the pane's local coordinates.
IPane
 Inherited
Retrieves the base event dispatcher object that allows access to event dispatching capability for cross-domain objects.
IWrappableEventDispatcher
  
getViewportBounds():Rectangle
Retrieves the bounds of the viewport in the pane's coordinate system.
IPane
  
invalidate():void
Invalidates all the geometry on the pane causing a delayed update.
IPane
  
removeOverlay(overlay:IOverlay):void
Removes an overlay from the pane.
IPane
  
updatePosition(force:Boolean = false):void
Updates this pane on changes to the map (such as panning and zooming).
IPane
Property detail
idproperty
id:uint  [read-only]

Pane's id.

Implementation
    public function get id():uint
mapproperty 
map:IMap  [read-only]

The instance of map this pane is added to. Null if the pane is removed from the map.

Implementation
    public function get map():IMap
paneManagerproperty 
paneManager:IPaneManager  [read-only]

The instance of pane manager this pane is added to. Null if the pane is removed from the map.

Implementation
    public function get paneManager():IPaneManager
visibleproperty 
visible:Boolean  [read-write]

Visibility of the pane.

Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method detail
addOverlay()method
public function addOverlay(overlay:IOverlay):void

Adds an overlay to the pane.

Parameters
overlay:IOverlay — Overlay to add to this pane.
bringToTop()method 
public function bringToTop(overlay:IOverlay):void

Brings an overlay to the top of all other overlays on the pane.

Parameters
overlay:IOverlay — Overlay to position at the top.
clear()method 
public function clear():void

Removes all overlays added to this pane.

fromLatLngToPaneCoords()method 
public function fromLatLngToPaneCoords(latLng:LatLng, closestToCenter:Boolean = false):Point

Translates the latLng to the pane's coordinate system. This method may be used by overlays displayed by the pane to determine their location. Pane's coordinate system may or may not match that of the map.

Parameters
latLng:LatLng — LatLng for the location to translate.
 
closestToCenter:Boolean (default = false) — If true, return the x coordinate closest to the centre of the map when multiple map copies are shown; if false, just map the latlng directly.

Returns
Point — Pixel coordinates within the pane for the specified latlng.
fromPaneCoordsToLatLng()method 
public function fromPaneCoordsToLatLng(point:Point, opt_nowrap:Boolean = false):LatLng

Translates a point in the pane's coordinate system to lat/lng. Pane's coordinate system may or may not match that of the map.

Parameters
point:Point — A point in the pane's coordinate system
 
opt_nowrap:Boolean (default = false) — Whether the value of longtitude should be preserved even when it value lies outside of the [-180, +180]. When this parameter if set to false (by default), the longtitude will be wrapped to bring it within the range [-180, +180].

Returns
LatLng — Corresponding lat/lng in the map
fromPaneCoordsToProjectionPoint()method 
public function fromPaneCoordsToProjectionPoint(point:Point):Point

Converts a point in the pane's coordinate system to projection point coordinates for the current zoom level of the map. Projection points are those returned by IProjection.fromLatLngToPixel (i.e. point (0,0) is the top-left corner of the top-left tile for the specific zoom level of the map).

Parameters
point:Point — Pixel coordinates within the pane

Returns
Point — Projection point coordinates for the current zoom level of the map
fromProjectionPointToPaneCoords()method 
public function fromProjectionPointToPaneCoords(projectionPoint:Point):Point

Converts projection point coordinates to the pane's local coordinates.

Parameters
projectionPoint:Point — Pixel coordinates of the object in relation to the origin of the map (i.e. point (0,0) is the top-left corner of the top-left tile for the specific zoom level of the map).

Returns
Point — Pixel coordinates within the pane.
getViewportBounds()method 
public function getViewportBounds():Rectangle

Retrieves the bounds of the viewport in the pane's coordinate system.

Returns
Rectangle — Viewport bounding rectangle.
invalidate()method 
public function invalidate():void

Invalidates all the geometry on the pane causing a delayed update.

removeOverlay()method 
public function removeOverlay(overlay:IOverlay):void

Removes an overlay from the pane.

Parameters
overlay:IOverlay — Overlay to remove from this pane.
updatePosition()method 
public function updatePosition(force:Boolean = false):void

Updates this pane on changes to the map (such as panning and zooming).

Parameters
force:Boolean (default = false) — Whether to force updates to all overlays on this pane.