Google Maps API ActionScript Reference

class Alpha

Alpha (opacity) constants. The main role of these constants is to improve code readability, using names that immediately suggest the effect that the chosen opacity value has.

Fields Summary

• OPAQUE
• PERCENT_0
• PERCENT_10
• PERCENT_100
• PERCENT_20
• PERCENT_30
• PERCENT_40
• PERCENT_50
• PERCENT_60
• PERCENT_70
• PERCENT_80
• PERCENT_90
• UNSEEN

Constants

Back to top

class Color

Color stores a color and provides methods for conversion between different textual and numeric representations of color.

Fields Summary

• BLACK
• BLUE
• CYAN
• DEFAULTLINK
• GRAY1
• GRAY10
• GRAY11
• GRAY12
• GRAY13
• GRAY14
• GRAY15
• GRAY2
• GRAY3
• GRAY4
• GRAY5
• GRAY6
• GRAY7
• GRAY8
• GRAY9
• GREEN
• MAGENTA
• RED
• WHITE
• YELLOW
• b
• g
• r
• rgb

Constructors Summary

• Color

Methods Summary

• incRGB
• setRGB
• toHtml
• toString

Constants

Properties

Constructors

Color(clr:Number)

Constructs a Color from a Number.

var col:Color = new Color(0x0000ff);  // blue

Static Methods

toHtml(color:Number): String

Returns a color in HTML format, for example '#321fba'. Clamps the number to the range [0x000000,0xffffff]. Returns the encoding for black if the input value is not a valid number.

var col:Color = new Color(0xff8020);
trace(col.toHtml());  // outputs "#ff8020"

Instance Methods

incRGB(deltaR:Number, deltaG:Number, deltaB:Number): void

Increments this color's R, G and B components by individual delta values. Each color component is clamped to the valid range [0,255].

var col:Color = new Color(0xff0000);  // color is red
col.incRGB(0, 255, 0);  // color is now yellow

setRGB(compR:Number, compG:Number, compB:Number): void

Sets this color from R, G and B components, all in the range [0,255].

var col:Color = new Color(0);
col.setRGB(128, 64, 255);  // lilac

toString(): String

Returns a string representation of this color, for example 'R:64/G:32/B:255'.

var col:Color = new Color(0xff8020);
trace(col.toString());  // outputs "R:255/G:128/B:32"

Back to top

class Copyright

This class contains information about which copyright message applies to a region of the map given by a rectangle, at a given range of zoom levels. You need this object only if you implement custom map types or tile layers.

Constructors Summary

• Copyright

Methods Summary

• getBounds
• getId
• getMaxZoom
• getMinZoom
• getText
• isSupplemental

Constructors

Copyright(id:String, bounds:LatLngBounds, minZoom:Number, text:String, opt_maxZoom?:Number, opt_isSupplemental?:Boolean)

Constructs a Copyright instance covering a geographical extent and range of zoom levels and specifies the id and text displayed for this instance.

// Create two Copyright instances. Company A's data is used
// throughout all zoom levels over a region spanning 10 degrees of latitude
// and 40 degrees of longitude. Company B's data supplements this over a
// much smaller region at zoom levels 14 and higher.
var regionCopyright:Copyright = new Copyright(
    'my_tileset_0',
    new LatLngBounds(new LatLng(10, 20), new LatLng(20, 60)),
    'Company A',
    0);
var cityCopyright:Copyright = new Copyright(
    'my_tileset_1',
    new LatLngBounds(new LatLng(12, 20), new LatLng(13, 21)),
    'Company B',
    14,
    true);

Instance Methods

getBounds(): LatLngBounds

Retrieves the spatial extent of the copyright.

var regionCopyright:Copyright = new Copyright(
    'my_tileset_0',
    new LatLngBounds(new LatLng(10, 20), new LatLng(20, 60)),
    'Company A',
    0);
trace(regionCopyright.getBounds());  // outputs "((10, 20), (20, 60))"

getId(): String

Retrieves the copyright id.

getMaxZoom(): Number

Retrieves the maximum zoom level that applies to the copyright.

getMinZoom(): Number

Retrieves the minimum zoom level that applies to the copyright.

getText(): String

Retrieves the copyright text.

isSupplemental(): Boolean

Returns true if this copyright is supplemental to copyright information from coarser zoom levels. If it is supplemental then it will be added to the coarser zoom level copyright information. If it is not supplemental then this copyright information is fully self-contained.

Back to top

class CopyrightCollection

CopyrightCollection manages copyright messages displayed on maps of custom map type. If you don't implement custom map types, then you don't need to use this class. A copyright collection contains information about which copyright to display for which region on the map at which zoom level. This is very important for map types that display heterogenous data such as the satellite map type.

Implements

• ICopyrightCollection
• flash.events.IEventDispatcher

Constructors Summary

• CopyrightCollection

Methods Summary

• addCopyright
• clearWrapper
• getCopyrightNotice
• getCopyrights
• getCopyrightsAtLatLng

Constructors

CopyrightCollection(opt_prefix?:String)

Creates a copyright collection for the given map type/spec.

Instance Methods

addCopyright(copyright:Copyright): Boolean

Adds the given copyright to the collection, returning true if the copyright was new and was added or false if the copyright was a duplicate and ignored.

clearWrapper(): void

Remove all event listeners and clear the wrapper.

getCopyrightNotice(bounds:LatLngBounds, zoom:Number): CopyrightNotice

Returns a CopyrightNotice instance for the given viewport.

getCopyrights(bounds:LatLngBounds, zoom:Number): Array

Retrieves an array of elements of type String, which comprises the copyright text that we should display for the given viewport.

getCopyrightsAtLatLng(latLng:LatLng): Array

Returns an array of elements of type Copyright, which are the copyrights pertaining to the specified location.

Back to top

class CopyrightNotice

CopyrightNotice stores an array of strings representing copyright text to display on the map, but can also be cast to a single text string. Copyright information for several data providers may apply to a region of the map: maintaining an array allows the text for the individual providers to be extracted. Use the toString method if you wish simply to obtain a single compound text string. You are unlikely to need to construct a CopyrightNotice yourself, but ICopyrightCollection provides a method, getCopyrightNotice() that returns an instance of this class.

Constructors Summary

• CopyrightNotice

Methods Summary

• getPrefix
• getTexts
• toString

Constructors

CopyrightNotice(prefix:String, copyrightTexts:Array)

Construct a CopyrightNotice from a text prefix and an array of elements of type String representing the individual copyright notices. Note that this class stores a reference to this array, rather than cloning the elements.

Instance Methods

getPrefix(): String

Retrieves the copyright prefix.

getTexts(): Array

Retrieves the array of copyright texts. Each element in this array is of type String.

toString(): String

Returns a single string made up of the prefix followed by a list of the text array elements.

var notice:CopyrightNotice = new CopyrightNotice(
    "Copyright",
    [ "Company A", "Company B" ]);
trace(notice.toString());  // outputs "Copyright Company A, CompanyB"

Back to top

class InfoWindowOptions

Class InfoWindowOptions specifies a set of rendering parameters for the info window.

Fields Summary

• ALIGN_CENTER
• ALIGN_LEFT
• ALIGN_RIGHT
• content
• contentFormat
• contentHTML
• contentStyleSheet
• cornerRadius
• customCloseRect
• customContent
• customOffset
• drawDefaultFrame
• fillStyle
• hasCloseButton
• hasShadow
• hasTail
• height
• padding
• pointOffset
• strokeStyle
• tailAlign
• tailHeight
• tailOffset
• tailWidth
• title
• titleFormat
• titleHTML
• titleStyleSheet
• width

Constructors Summary

• InfoWindowOptions

Methods Summary

• getDefaultOptions
• setDefaultOptions
• toString

Constants

Properties

Constructors

InfoWindowOptions(param?:Object)

Constructs an InfoWindowOptions object, optionally initializing it from an object.

// Specifying all InfoWindowOptions properties.
var titleFormat:TextFormat = new TextFormat();
textFormat.bold = true;
var titleStyleSheet:StyleSheet = new StyleSheet();
var h1:Object = {
  color: "#FFFF80",
  fontWeight: "bold" };
titleStyleSheet.setStyle("h1", h1);
var contentStyleSheet:StyleSheet = new StyleSheet();
var body:Object = {
  color: "#FF0080",
  fontStyle: "italic" };
contentStyleSheet.setStyle("body", body);
var contentFormat:TextFormat = new TextFormat("Arial", 10);
var options:InfoWindowOptions = new InfoWindowOptions({
  strokeStyle: {
    color: 0x987654
  },
  fillStyle: {
    color: 0x223344,
    alpha: 0.8
  },
  titleFormat: titleFormat,
  titleStyleSheet: titleStyleSheet,
  contentFormat: contentFormat,
  contentStyleSheet: contentStyleSheet,
  width: 200,
  cornerRadius: 12,
  padding: 10,
  hasCloseButton: true,
  hasTail: true,
  tailWidth: 20,
  tailHeight: 30,
  tailOffset: -12,
  tailAlign: InfoWindowOptions.ALIGN_LEFT,
  pointOffset: new Point(3, 8),
  hasShadow: true
});

Static Methods

getDefaultOptions(): InfoWindowOptions

Retrieves the InfoWindowOptions instance that represents the default set of options that applies to all info windows.

// Initialization object corresponding to the initial defaults.
var titleStyleSheet:StyleSheet = new StyleSheet();
titleStyleSheet.setStyle("p", { fontFamily: "_sans" });
var contentStyleSheet:StyleSheet = new StyleSheet();
contentStyleSheet.setStyle("p", { fontFamily: "_sans" });
var initObject:Object = {
  strokeStyle: {
    thickness: 2,
    alpha: 1.0,
    color:Color.BLACK
  },
  fillStyle: {
    color: 0xffffff,
    alpha: 1.0
  },
  title: null,
  titleHTML: null,
  titleFormat: new TextFormat("_sans"),
  titleStyleSheet: titleStyleSheet,
  content: null,
  contentHTML: null,
  contentFormat: new TextFormat("_sans"),
  contentStyleSheet: contentStyleSheet,
  width: 200,
  height: null,
  cornerRadius: 5,
  padding: 0,
  hasCloseButton: true,
  hasTail: true,
  tailWidth: 20,
  tailHeight: 20,
  tailOffset: 0,
  tailAlign: InfoWindowOptions.ALIGN_LEFT,
  pointOffset: new Point(0, 0),
  hasShadow: true,
  customContent: null,
  customOffset: null,
  customCloseRect: null
}

setDefaultOptions(defaults:InfoWindowOptions): void

Sets the default set of options that applies to all infowindows. Options may also be set for the infowindow individually in the openInfoWindow call. If that is the case, options specified in that call will take precedence over the default options. The defaults parameter may specify a complete or partial set of infowindow options. If a partial set of options is specified, it will supplement the existing defaults, overriding only the values that were set explicitly and leaving the rest unchanged.

Instance Methods

toString(): String

Returns a String representation of this object.

Back to top

class LatLng

LatLng is a point in geographical coordinates with longitude and latitude. Notice that although usual map projections associate longitude with the x-coordinate of the map, and latitude with the y-coordinate, the latitude coordinate is always written first, followed by the longitude, as is customary in cartography. Notice also that you cannot modify the coordinates of a LatLng. If you want to compute another point, you have to create a new one.

Fields Summary

• EARTH_RADIUS

Constructors Summary

• LatLng

Methods Summary

• angleFrom
• clone
• distanceFrom
• equals
• fromRadians
• fromUrlValue
• lat
• latRadians
• lng
• lngRadians
• toString
• toUrlValue
• wrapLatLng

Constants

Constructors

LatLng(lat:Number, lng:Number, opt_noCorrect?:Boolean)

Constructs a LatLng. If opt_noCorrect is false, we make sure the latitude and longitude are valid, wrapping the longitude appropriately around the dateline and clamping the latitude at the poles. Valid values for longitude lie in the range [-180,180]. Valid values for latitude lie in the range [-90,90].

// Construct three LatLng instances.
var sydney:LatLng = new LatLng(-33.8581, 151.2149);
var bound:LatLng = new LatLng(10, 190);  // longitude set to -170
var unbound:LatLng = new LatLng(10, 190, true);  // longitude set to 190

Static Methods

fromRadians(lat:Number, lng:Number, opt_noCorrect?:Boolean): LatLng

Creates a latlng from radian values.

fromUrlValue(value:String): LatLng

Parses a string of the form "lat,lng" and returns a point with those values.

// Create a LatLng from a text string.
var location:LatLng = LatLng.fromUrlValue("-34,151");

wrapLatLng(latLng:LatLng): LatLng

Returns a LatLng that is a copy of the given LatLng, but with latitude clamped to the range [-90, 90] and longitude wrapped to the range [-180, 180].

Instance Methods

angleFrom(other:LatLng): Number

Returns the angle (radians) between this point and the given point. This is also the distance between those points on a unit sphere.

// Calculate angle in radians between London and Paris.
var london:LatLng = new LatLng(51.53, -0.08);
var paris:LatLng = new LatLng(48.8, 2.33);
trace("angle: " + paris.angleFrom(london));

clone(): LatLng

Returns a new LatLng object that is a copy of this.

distanceFrom(other:LatLng, opt_radius?:Number): Number

Returns the distance, in meters, from this point to the given point. Since we approximate the earth as a sphere, the distance could be off by as much as 0.3%.

// Calculate distance in km between London and Sydney.
var london:LatLng = new LatLng(51.53, -0.08);
var sydney:LatLng = new LatLng(-34.0, 151.0);
trace("km: " + sydney.distanceFrom(london) / 1000);

equals(other:LatLng): Boolean

Tests whether this LatLng is coincident with another specified LatLng, allowing for numerical rounding errors.

lat(): Number

Returns the latitude in degrees.

latRadians(): Number

Returns the latitude in radians.

lng(): Number

Returns the longitude in degrees.

lngRadians(): Number

Returns the longitude in radians.

toString(): String

Returns a string representation of this LatLng, for example '48.8584, 2.2944' for Paris.

toUrlValue(opt_precision?:Number): String

Returns a string of the form "lat,lng" for this LatLng. We round the lat/lng values to 6 decimal places by default. <table> <tr><th>precision</th><th>approximate error</tr> <tr><td>-1</td><td>1000 kilometers / 700 miles</tr> <tr><td>0</td><td>100 kilometers / 70 miles</tr> <tr><td>1</td><td>10 kilometers / 7 miles</tr> <tr><td>2</td><td>1 kilometer / 0.7 miles</tr> <tr><td>3</td><td>100 meters / 300 feet</tr> <tr><td>4</td><td>10 meters / 30 feet</tr> <tr><td>5</td><td>1 meter / 3 feet</tr> <tr><td>6</td><td>10 centimeters / 4 inches</tr> <tr><td>7</td><td>1 centimeter (a nickel)</tr> </table>

Back to top

class LatLngBounds

A rectangular bounds on the Earth. The 2D interval is directed, i.e. it extends from the SW corner to the NE corner, even if the longitude interval from NE to SW (the other way round the earth) would be smaller. The bounds can be extended to contain new points with the extend() method.

Constructors Summary

• LatLngBounds

Methods Summary

• clone
• containsBounds
• containsLatLng
• equals
• extend
• getCenter
• getEast
• getNorth
• getNorthEast
• getNorthWest
• getSouth
• getSouthEast
• getSouthWest
• getWest
• intersects
• isEmpty
• isFullLat
• isFullLng
• isLargerThan
• toSpan
• toString
• union

Constructors

LatLngBounds(opt_sw?:LatLng, opt_ne?:LatLng)

Constructs a LatLngBounds from two LatLng instances, holding the SW extent and NE extent, respectively. A LatLngBounds instance represents a rectangle in geographical coordinates, including one that crosses the 180 degrees meridian.

var bounds:LatLngBounds = new LatLngBounds(
    new LatLng(10, 50),   // spans 1 degree latitude
    new LatLng(11, 52));  // and 2 degrees longitude

Instance Methods

clone(): LatLngBounds

Creates a clone of this instance.

containsBounds(other:LatLngBounds): Boolean

Returns true if this bounds completely contains the given bounds.

var bounds:LatLngBounds = new LatLngBounds(
    new LatLng(10, 50), new LatLng(20, 70));
trace(bounds.containsBounds(
    new LatLngBounds(
        new LatLng(11, 12), new LatLng(52, 68)));  // outputs true

containsLatLng(point:LatLng): Boolean

Returns true if the given lat/lng is in this bounds.

var bounds:LatLngBounds = new LatLngBounds(
    new LatLng(10, 50),
    new LatLng(20, 70));
trace(bounds.containsLatLng(new LatLng(15, 51)));  // outputs true
trace(bounds.containsLatLng(new LatLng(29, 51)));  // outputs false

equals(other:LatLngBounds): Boolean

Returns true if this bounds equals the given bound, allowing for numerical rounding errors.

extend(point:LatLng): void

Extends this bounds to contain the given point.

var bounds:LatLngBounds = new LatLngBounds(
    new LatLng(1, 5), new LatLng(2, 7));
bounds.extend(new LatLng(0, 9));
trace(bounds.toString());  // outputs "((0, 5), (2, 9))"

getCenter(): LatLng

Computes the center of this LatLngBounds

var bounds:LatLngBounds = new LatLngBounds(
    new LatLng(10, 50),
    new LatLng(20, 70));
trace(bounds.getCenter());  // outputs "(15, 60)"

getEast(): Number

Returns the east longitude of this bounds.

getNorth(): Number

Returns the north latitude of this bounds.

getNorthEast(): LatLng

Returns the north-east corner of this bounds.

getNorthWest(): LatLng

Returns the north-west corner of this bounds.

getSouth(): Number

Returns the south latitude of this bounds.

getSouthEast(): LatLng

Returns the south-east corner of this bounds.

getSouthWest(): LatLng

Returns the south-west corner of this bounds.

getWest(): Number

Returns the west longitude of this bounds.

intersects(other:LatLngBounds): Boolean

Returns true if this bounds shares any points with this bounds.

isEmpty(): Boolean

Returns true if the bounds are empty.

isFullLat(): Boolean

Returns true if the bounds cover all latitudes.

isFullLng(): Boolean

Returns true if the bounds cover all longitudes.

isLargerThan(other:LatLngBounds): Boolean

Returns true if this bounds is larger than (could contain) the other.

toSpan(): LatLng

Converts the given map bounds to a lat/lng span.

var bounds:LatLngBounds = new LatLngBounds(
    new LatLng(10, 50), new LatLng(20, 70));
trace(bounds.toSpan());  // outputs "(10, 20)"

toString(): String

Converts this LatLngBounds to a string.

var bounds:LatLngBounds = new LatLngBounds(
    new LatLng(1, 5),
    new LatLng(2, 7));
trace(bounds.toString());  // outputs "((1, 5), (2, 7))"

union(other:LatLngBounds): void

Extends this bounds to contain the union of this and the given bounds.

var bounds:LatLngBounds = new LatLngBounds(
    new LatLng(0, 0), new LatLng(1, 1));
bounds.union(
    new LatLngBounds(
        new LatLng(10, 20), new LatLng(15, 22)));
trace(bounds.toString());  // outputs "((0, 0), (15, 22))"

Back to top

class Map

This is the main class of the Maps API for Flash. Instantiate Map to create a map.

Implements

• IMap

Fields Summary

• MERCATOR_PROJECTION
• countryCode
• key
• language
• languages
• overlayRaising
• url
• version

Constructors Summary

• Map

Methods Summary

• addControl
• addMapType
• addOverlay
• callLater
• clearControls
• clearOverlays
• clearWrapper
• closeInfoWindow
• continuousZoomEnabled
• controlByKeyboardEnabled
• crosshairsEnabled
• delayCall
• disableContinuousZoom
• disableControlByKeyboard
• disableCrosshairs
• disableDragging
• disableScrollWheelZoom
• draggingEnabled
• enableContinuousZoom
• enableControlByKeyboard
• enableCrosshairs
• enableDragging
• enableScrollWheelZoom
• fromLatLngToPoint
• fromLatLngToViewport
• fromPointToLatLng
• fromViewportToLatLng
• getBoundsZoomLevel
• getCenter
• getCurrentMapType
• getDisplayObject
• getDoubleClickMode
• getImplementationVersion
• getInterfaceVersion
• getLatLngBounds
• getMapTypes
• getMaxZoomLevel
• getMinZoomLevel
• getOptions
• getPaneManager
• getProjection
• getSize
• getZoom
• isLoaded
• openInfoWindow
• panBy
• panTo
• removeControl
• removeMapType
• removeOverlay
• returnToSavedPosition
• savePosition
• scrollWheelZoomEnabled
• setCenter
• setDoubleClickMode
• setInitOptions
• setMapType
• setSize
• setZoom
• unload
• zoomIn
• zoomOut

Properties

Constructors

Map()

Constructor. When this runs none of the bindable variables has yet been initialized. We defer actions that depend upon them until we have been added to the stage.

Instance Methods

addControl(control:IControl): void

Registers a new control. This can be called before the MAP_READY event has been received.

public class MyMap extends Map {
  public function MyMap() {
    super();
    addEventListener(MapEvent.MAP_READY, onMapReady);
    addControl(new MapTypeControl());
  }
}

addMapType(newMapType:IMapType): void

Registers a new map type.

addOverlay(overlay:IOverlay): void

Adds an overlay to the map.

var marker:Marker = new Marker(
    new LatLng(48.858842, 2.346997),
    new MarkerOptions({ fillRGB: 0x004000,
                        name: "Paris, France",
                        description: "City on the Seine" }));
map.addOverlay(marker);

callLater(call:Function): void

clearControls(): void

Removes all controls from the map.

clearOverlays(): void

Removes all overlays from the map.

clearWrapper(): void

Remove all event listeners and clear the wrapper.

closeInfoWindow(): Boolean

Closes the information window.

continuousZoomEnabled(): Boolean

Checks whether continuous zoom is enabled.

controlByKeyboardEnabled(): Boolean

Checks whether control by keyboard is enabled.

crosshairsEnabled(): Boolean

Checks whether center crosshairs are enabled.

delayCall(call:Function): void

Delay a method call until the next frame.

disableContinuousZoom(): void

Disables continuous smooth zooming.

disableControlByKeyboard(): void

Disables control by keyboard.

disableCrosshairs(): void

Disables the center crosshairs.

disableDragging(): void

Disables dragging of the map.

disableScrollWheelZoom(): void

Disables zooming using a mouse's scroll wheel.

draggingEnabled(): Boolean

Checks whether dragging of the map is enabled.

enableContinuousZoom(): void

Enables continuous smooth zooming.

enableControlByKeyboard(): void

Enables control by keyboard.

enableCrosshairs(): void

Enables the center crosshairs.

enableDragging(): void

Enables dragging of the map.

enableScrollWheelZoom(): void

Enables zooming using a mouse's scroll wheel.

fromLatLngToPoint(latLng:LatLng, opt_zoom?:Number): Point

Returns x,y coordinates of specified lat, lng and zoom relative to the origin of the map's projection (the origin is the top left corner of the top left tile of the map for the specified map zoom level).

fromLatLngToViewport(latLng:LatLng, opt_disablewrap?:Boolean): Point

Returns the pixel coordinates for the specified latLng location in the coordinate system of the map's view port ([0,0] being the top left corner of the map object).

fromPointToLatLng(pos:Point, opt_zoom?:Number, opt_nowrap?:Boolean): LatLng

Returns lat,lng coordinates of specified x, y and zoom. The coordinates are relative to the origin of the map's projection (the top left corner of the top left tile of the map for the specified zoom level).

fromViewportToLatLng(pos:Point, opt_nowrap?:Boolean): LatLng

Returns the lat-lng of the point at the given coordinates in the map's view port (the top left corner of the map object).

getBoundsZoomLevel(bounds:LatLngBounds): Number

Returns the highest resolution zoom level at which the given rectangular region fits in the map view. The zoom level is computed for the currently selected map type.

getCenter(): LatLng

Retrieves coordinates of the center in the map view control.

getCurrentMapType(): IMapType

Retrieves the current map type.

getDisplayObject(): DisplayObject

Retrieves the display object that represents the map.

getDoubleClickMode(): Number

Get the mouse double click mode.

getImplementationVersion(): String

Gets the version of the implementation library SWF.

getInterfaceVersion(): String

Retrieves the version of the client interface.

getLatLngBounds(): LatLngBounds

Returns the the visible rectangular region of the map view in geographical coordinates.

getMapTypes(): Array

Retrieves the list of the map types available for the location.

getMaxZoomLevel(opt_mapType?:IMapType, opt_point?:LatLng): Number

Retrieves the maximum zoom level.

getMinZoomLevel(opt_mapType?:IMapType, opt_point?:LatLng): Number

Retrieves the minimum zoom level.

getOptions(): MapOptions

Retrieves the full set of options used by the map. Note that since MapOptions is used only during map initialization, this method only allows those original settings to be retrieved and does not support re-configuration of the map.

getPaneManager(): IPaneManager

Retrieves the pane manager for the map.

getProjection(): IProjection

Returns the projection being applied to the map.

getSize(): Point

Retrieves the map view size.

getZoom(): Number

Retrieves the map zoom level.

isLoaded(): Boolean

Checks whether the map has been initialized.

openInfoWindow(latlng:LatLng, options?:InfoWindowOptions): IInfoWindow

Opens a simple information window at the given point.

panBy(distance:Point): void

Starts a pan animation by the given distance in pixels.

panTo(latLng:LatLng): void

Pans the map to the specified centre location.

removeControl(control:IControl): void

Removes a control from the map. If the control was not added to the map, this does nothing.

removeMapType(oldMapType:IMapType): void

Removes a registered map type.

removeOverlay(overlay:IOverlay): void

Removes an overlay from the map.

returnToSavedPosition(): void

Returns map to the saved position.

savePosition(): void

Stores the current map position and zoom level for later recall by returnToSavedPosition.

scrollWheelZoomEnabled(): Boolean

Checks whether scroll wheel zooming is enabled.

setCenter(latLng:LatLng, opt_zoom?:Number, opt_mapType?:IMapType): void

Changes the centre point of the map.

setDoubleClickMode(val:Number): void

Set the mouse double click mode.

setInitOptions(options:MapOptions): void

Sets the options used to initialize the Map. You should ONLY call this method whilst handling a MapEvent.MAP_PREINITIALIZE event. Before this event values which you need for MapOptions properties may not themselves have been configured. After this event map initialization will have progressed past the point at which MapOptions properties are used.

setMapType(mapType:IMapType): void

Changes the map type for the map.

setSize(newSize:Point): void

Sets the size of the map view.

setZoom(level:Number, opt_doContinuousZoom?:Boolean): void

Changes the zoom level for the map view control.

unload(): void

Removes the map from its parent and attempts to unload it to free up memory associated with the map. The map object will no longer be usable after the call to this method.

zoomIn(opt_latlng?:LatLng, opt_doCenter?:Boolean, opt_doContinuousZoom?:Boolean): void

Zooms in the map by one zoom level if possible.

zoomOut(opt_latlng?:LatLng, opt_doContinuousZoom?:Boolean): void

Zooms out the map by one zoom level if possible.

Back to top

class MapAction

Constants used to identify map actions.

Fields Summary

• ACTION_NOTHING
• ACTION_PAN
• ACTION_PAN_ZOOM_IN
• ACTION_ZOOM_IN

Constants

Back to top

class MapEvent

A MapEvent object is dispatched into the event flow whenever map-specific events occur. Map events may be dispatched by the map object itself or its elements (i.e. overlays/infowindows etc).

Fields Summary

• CONTROL_ADDED
• CONTROL_REMOVED
• COPYRIGHTS_UPDATED
• INFOWINDOW_CLOSED
• INFOWINDOW_CLOSING
• INFOWINDOW_OPENED
• MAPTYPE_ADDED
• MAPTYPE_CHANGED
• MAPTYPE_REMOVED
• MAP_PREINITIALIZE
• MAP_READY
• OVERLAY_BEFORE_REMOVED
• OVERLAY_MOVED
• OVERLAY_REMOVED
• SIZE_CHANGED
• VISIBILITY_CHANGED
• feature

Constructors Summary

• MapEvent

Constants

Properties

Constructors

MapEvent(type:String, feature:Object, bubbles?:Boolean, cancellable?:Boolean)

Creates an Event object to pass as a parameter to event listeners.

Back to top

class MapMouseEvent

A MapMouseEvent object is dispatched into the event flow whenever a mouse-related event specific to the map or its overlays occurs.

Fields Summary

• CLICK
• DOUBLE_CLICK
• DRAG_END
• DRAG_START
• DRAG_STEP
• MOUSE_DOWN
• MOUSE_MOVE
• MOUSE_UP
• ROLL_OUT
• ROLL_OVER
• altKey
• ctrlKey
• latLng
• shiftKey

Constructors Summary

• MapMouseEvent

Constants

Properties

Constructors

MapMouseEvent(type:String, feature:Object, latLng:LatLng, bubbles?:Boolean, cancellable?:Boolean, ctrlKey?:Boolean, altKey?:Boolean, shiftKey?:Boolean)

Creates a MapMouseEvent object to pass as a parameter to event listeners.

Back to top

class MapMoveEvent

A MapMoveEvent object is dispatched into the event flow whenever the map view is changing.

Fields Summary

• MOVE_END
• MOVE_START
• MOVE_STEP
• latLng

Constructors Summary

• MapMoveEvent

Constants

Properties

Constructors

MapMoveEvent(type:String, latLng:LatLng, bubbles?:Boolean, cancellable?:Boolean)

Creates a MapMoveEvent object to pass as a parameter to event listeners.

Back to top

class MapOptions

MapOptions specifies a set of parameters for initialization of the map. Please note that there is a very specific time when you should use MapOptions and that is whilst handling a MapEvent.MAP_PREINITIALIZE event.

Fields Summary

• backgroundFillStyle
• center
• continuousZoom
• controlByKeyboard
• crosshairs
• crosshairsStrokeStyle
• doubleClickMode
• dragging
• mapType
• mapTypes
• mouseClickRange
• overlayRaising
• zoom

Constructors Summary

• MapOptions

Methods Summary

• toString

Properties

Constructors

MapOptions(param?:Object)

Constructs a new MapOptions object, optionally initializing it from an object.

// Creating a MapOptions instance that corresponds to the default
// configuration for creating a map.
var options:MapOptions = new MapOptions({
  backgroundFillStyle: {
    alpha: Alpha.OPAQUE,
    color: Color.GRAY14
  },
  crosshairs: false,
  crosshairsStrokeStyle: {
    thickness: 1,
    color: Color.BLACK,
    alpha: 1,
    pixelHinting: false
  },
  controlByKeyboard: false,
  overlayRaising: true,
  doubleClickMode: MapAction.ACTION_PAN_ZOOM_IN,
  dragging: true,
  continuousZoom: false,
  mapType: null,
  mapTypes: null,
  center: new LatLng(0, 0),
  zoom: 1
  mouseClickRange: 2
});

Instance Methods

toString(): String

Returns a String representation of this object.

Back to top

class MapType

Defines a map type for the Map. A map type is a set of tile layers, a map projection, a tile size, and assorted other settings, such as link colors and copyrights.

Implements

• IMapType
• flash.events.IEventDispatcher

Fields Summary

• DEFAULT_MAP_TYPES
• HYBRID_MAP_TYPE
• NORMAL_MAP_TYPE
• PHYSICAL_MAP_TYPE
• SATELLITE_MAP_TYPE

Constructors Summary

• MapType

Methods Summary

• clearWrapper
• getAlt
• getBoundsZoomLevel
• getCopyrights
• getErrorMessage
• getLinkColor
• getMaxResolutionOverride
• getMaximumResolution
• getMinimumResolution
• getName
• getProjection
• getRadius
• getSpanZoomLevel
• getTextColor
• getTileLayers
• getTileSize
• getUrlArg
• setMaxResolutionOverride

Properties

Constructors

MapType(tileLayers:Array, projection:IProjection, name:String, options?:MapTypeOptions)

Creates an instance of MapType object (for custom map types).

Instance Methods

clearWrapper(): void

Remove all event listeners and clear the wrapper.

getAlt(): String

Returns the text of the hint that is displayed when the user hovers over a control that allows selection of this map type. MapTypeControl is such a control.

getBoundsZoomLevel(bounds:LatLngBounds, viewSize:Point): Number

Returns the highest resolution zoom level required to show the given lat/lng bounds in a map of the given pixel size.

getCopyrights(bounds:LatLngBounds, zoom:Number): Array

Returns an array of copyright notices for the given bounds and zoom level. Each element in this array is of type CopyrightNotice.

getErrorMessage(): String

Returns the text to be displayed if a tile fails to download.

getLinkColor(): Number

If a control displays a link above the map, returns the color we should use. The "terms of use" link in the copyright control uses this color, for example.

getMaxResolutionOverride(): Number

Returns the max resolution override.

getMaximumResolution(opt_point?:LatLng): Number

Returns the zoom level of the maximum resolution supported by this map type. If opt_point is given, returns the maximum resolution at the given lat/lng. If opt_point is not given, returns the global maximum.

getMinimumResolution(opt_point?:LatLng): Number

Returns the zoom level of the minimum resolution supported by this map type. If opt_point is given, returns the minimum resolution at the given lat/lng. If opt_point is not given, returns the global minimum.

getName(opt_short?:Boolean): String

Retrieves the map type name.

getProjection(): IProjection

Retrieves the map type projection.

getRadius(): Number

Returns the radius of the planet for which this map type is defined.

getSpanZoomLevel(center:LatLng, span:LatLng, viewSize:Point): Number

Returns the highest resolution zoom level required to show the given lat/lng span with the given center point.

getTextColor(): Number

If controls are textual, returns the appropriate color to display the text. The copyright control uses this color, for example.

getTileLayers(): Array

Gets the list of tile layers for this map type.

getTileSize(): Number

Gets the tile size for this map type. The predefined map types' tiles are all 256 by 256 pixels in size: this function would, for these map types, return 256.

getUrlArg(): String

Returns a string that may be used as a URL parameter to identify this map type in permalinks to the current map view. This is currently only used by the maps application.

setMaxResolutionOverride(maxResolution:Number): void

Sets the max resolution override, such that, if this number is greater than the max resolution that our map type reports to us, we will use this number instead. It represents the number of levels shown on the ZoomControl's scrollbar.

Back to top

class MapTypeOptions

MapTypeOptions class specifies a set of parameters for map types.

Fields Summary

• alt
• errorMessage
• linkColor
• maxResolution
• minResolution
• radius
• shortName
• textColor
• tileSize
• urlArg

Constructors Summary

• MapTypeOptions

Methods Summary

• getDefaultOptions
• setDefaultOptions
• toString

Properties

Constructors

MapTypeOptions(param?:Object)

Constructs a new MapTypeOptions object, optionally initializing it from an object.

var options:MapTypeOptions = new MapTypeOptions({
  shortName: "sea",
  urlArg: "s",
  maxResolution: 16,
  minResolution: 4,
  tileSize: 256,
  textColor: Color.BLACK,
  linkColor: Color.RED,
  errorMessage: "This sea tile could not be loaded",
  alt: "Sea images",
  radius: 51118000
});

Static Methods

getDefaultOptions(): MapTypeOptions

Retrieves the MapTypeOptions instance that represents the default set of options that applies to all map types.

// Initialization object corresponding to the initial defaults.
{ shortName: new String(""),
  urlArg: new String("c"),
  tileSize: 256,
  textColor: Color.BLACK,
  linkColor: Color.DEFAULTLINK,
  errorMessage: new String(""),
  alt: new String(""),
  radius: LatLng.EARTH_RADIUS
}

setDefaultOptions(defaults:MapTypeOptions): void

Sets the default set of options that applies when new map types are created. Options may also be set for each individual map type. If that is the case, options specified for an individual map type will take precedence over the default options. The defaults parameter may specify a complete or partial set of map type options. If a partial set of options is specified, it will supplement the existing defaults, overriding only the values that were set explicitly and leaving the rest unchanged.

Instance Methods

toString(): String

Returns a String representation of this object.

Back to top

class MapZoomEvent

A MapMouseEvent object is dispatched into the event flow whenever the map is being zoomed in or out.

Fields Summary

• CONTINUOUS_ZOOM_END
• CONTINUOUS_ZOOM_START
• CONTINUOUS_ZOOM_STEP
• ZOOM_CHANGED
• ZOOM_RANGE_CHANGED
• zoomLevel

Constructors Summary

• MapZoomEvent

Constants

Properties

Constructors

MapZoomEvent(type:String, zoomLevel:Number, bubbles?:Boolean, cancellable?:Boolean)

Creates a MapZoomEvent object to pass as a parameter to event listeners.

Back to top

class PaneId

Constants used to identify panes on the map. Note that whilst each of these constants has a numeric value, pane ordering is managed independently of the actual values.

Fields Summary

• PANE_FLOAT
• PANE_MAP
• PANE_MARKER
• PANE_OVERLAYS

Constants

Back to top

class ProjectionBase

ProjectionBase is an abstract base class for creating custom projections. Sub-class this and implement each method to create a custom projection for the map.

Implements

• IProjection

Constructors Summary

• ProjectionBase

Methods Summary

• fromLatLngToPixel
• fromPixelToLatLng
• getWrapWidth
• tileCheckRange

Constructors

ProjectionBase()

Constructs an instance of ProjectionBase.

Instance Methods

fromLatLngToPixel(latLng:LatLng, zoom:Number): Point

Returns the map pixel coordinates corresponding to the specified geographical location and zoom level.

fromPixelToLatLng(pixel:Point, zoom:Number, opt_nowrap?:Boolean): LatLng

Returns the geographical location corresponding to the specified map pixel coordinates and zoom level.

getWrapWidth(zoom:Number): Number

Returns the map periodicity in the x-direction: the number of pixels after which the map repeats itself because it wraps around the earth. By default, returns Infinity, i.e. the map does not repeat itself. This is used by the map to compute the placement of overlays on map views that contain more than one copy of the earth (this usually happens only at low zoom levels).

tileCheckRange(tile:Point, zoom:Number, tileSize:Number): Boolean

Tests whether the tile index is within the valid range for the map type (the map displays empty tiles outside of this range). Note that this function may modify the tile index to point to another instance of the same tile should the map contain more than one Earth.

Back to top

class TileLayerBase

TileLayerBase is an abstract base class used to provide custom tile layers for the map. Sub-class this and override the appropriate methods to create a custom tile layer. You must override the loadTile() method. You are free to override the other methods as necessary for your application.

Implements

• ITileLayer

Constructors Summary

• TileLayerBase

Methods Summary

• getAlpha
• getCopyrightCollection
• getMapType
• getMaxResolution
• getMinResolution
• loadTile
• setMapType

Constructors

TileLayerBase(copyrightCollection:ICopyrightCollection, minResolution?:Number, maxResolution?:Number, alpha?:Number)

Constructs a TileLayerBase instance. This should be called only from within the constructor of a class that extends TileLayerBase.

package com.mycompany.maps {
  import com.google.maps.TileLayerBase;
  public class MyTileLayer extends TileLayerBase {
    public function MyTileLayer(copyrightCollection:ICopyrightCollection,
                                minResolution:Number = NaN,
                                maxResolution:Number = NaN,
                                alpha:Number=Alpha.OPAQUE) {
      super(copyrightCollection, minResolution, maxResolution, alpha);
    }
  }
  //  :
  // Overridden methods to implement a custom tile layer
  //  :
}

Instance Methods

getAlpha(): Number

Returns the opacity (alpha value) of this tile layer. The range of values for getAlpha() is [0,1]. A value of 0 means that the layer is invisible (fully transparent); a value of 1, fully opaque.

getCopyrightCollection(): ICopyrightCollection

Retrieves the copyright collection responsible for handling copyright for this tile layer.

getMapType(): IMapType

Retrieves the map type for this tile layer.

getMaxResolution(): Number

Returns the finest zoom level.

getMinResolution(): Number

Returns the coarsest zoom level.

loadTile(tilePos:Point, zoom:Number): DisplayObject

Creates and loads a tile (x, y) at the given zoom level. You must override this and return a DisplayObject holding your custom tile. Do not call the base class version of this method in your sub-class' implementation.

public override function loadTile(
    tilePos:Point, zoom:Number):DisplayObject {
  var loader:Loader = new Loader();
  var tileUrl:String = "http://tiles.mycompany.com/tile_" +
      tilePos.x + "_" + tilePos.y + "_" + zoom + ".png";
  loader.load(new URLRequest(tileUrl));
  return loader;
}

setMapType(mapType:IMapType): void

Sets the map type for this tile layer.

Back to top

class ControlBase

Base class for controls. Sub-class this to provide a custom control for the map.

Implements

• IControl

Fields Summary

• map
• position

Constructors Summary

• ControlBase

Methods Summary

• clearWrapper
• getControlPosition
• getDisplayObject
• getSize
• initControlWithMap
• setControlPosition

Properties

Constructors

ControlBase(position:ControlPosition)

Construct a control located relative to a specfied corner of the map.

// MyControl is a developer-created sub-class of ControlBase.
var control:MyControl = new MyControl(
    new ControlPosition(ControlPosition.ANCHOR_TOP_RIGHT, 2, 2));

Instance Methods

clearWrapper(): void

Remove all event listeners and clear the wrapper.

getControlPosition(): ControlPosition

Retrieves the control position.

getDisplayObject(): DisplayObject

Retrieves the control's display object (typically, the control itself).

getSize(): Point

Retrieves the control's size.

initControlWithMap(map:IMap): void

Sets the instance of the map that the control operates on. Normally invoked automatically from the call to Map.addControl().

setControlPosition(controlPosition:ControlPosition): void

Changes control's position.

Back to top

class ControlPosition

ControlPosition describes the position of a control in the map view. It specifies which corner of the map view is to be treated as a reference point and the X and Y padding offsets from this corner.

Fields Summary

• ANCHOR_BOTTOM_LEFT
• ANCHOR_BOTTOM_RIGHT
• ANCHOR_TOP_LEFT
• ANCHOR_TOP_RIGHT

Constructors Summary

• ControlPosition

Methods Summary

• getAnchor
• getOffsetX
• getOffsetY
• toString

Constants

Constructors

ControlPosition(anchor:Number, opt_paddingX?:Number, opt_paddingY?:Number)

Constructs a ControlPosition from offsets relative to a specified map corner.

// Create a ControlPosition instance to anchor a control 16 pixels
// left of and 10 pixels below the top-right corner of the map.
var position:ControlPosition = new ControlPosition(
  ControlPosition.ANCHOR_TOP_RIGHT, 16, 10);

Instance Methods

getAnchor(): Number

Retrieves the anchor identifier.

// Test whether a position is anchored to the map's bottom-left
// corner.
if (position.getAnchor()==ControlPosition.ANCHOR_BOTTOM_LEFT)
  trace("Positioned relative to the map's bottom-left corner.");

getOffsetX(): Number

Retrieves the horizontal offset.

getOffsetY(): Number

Retrieves the vertical offset.

toString(): String

String representation of position object.

Back to top

class MapTypeControl

A MapTypeControl provides a control for selecting and switching between supported map types via buttons. Controls will be made available for all map types currently attached to the map at the time the control is constructed. By default, maps support the set of MapType.DEFAULT_MAP_TYPES; additional map types can be added explicitly via Map.addMapType().

Implements

• IControl

Constructors Summary

• MapTypeControl

Methods Summary

• clearWrapper
• getControlPosition
• getDisplayObject
• getSize
• initControlWithMap
• setControlPosition

Constructors

MapTypeControl(options?:MapTypeControlOptions)

Constructs a MapTypeControl object.

Instance Methods

clearWrapper(): void

Remove all event listeners and clear the wrapper.

getControlPosition(): ControlPosition

Retrieves the control position.

getDisplayObject(): DisplayObject

Retrieves the control's display object (often this would be the control object itself, but potentially be a different object if the control contains a sprite rather than extending it).

getSize(): Point

Retrieves the control's size.

initControlWithMap(map:IMap): void

Sets the instance of the map that this control operates on. Normally invoked from the call to Map.addControl().

setControlPosition(position:ControlPosition): void

Sets the control's position and updates its position on the map.

navigatorControl.setControlPosition(
    new ControlPosition(ControlPosition.ANCHOR_TOP_RIGHT, 2, 2));

Back to top

class MapTypeControlOptions

Class MapTypeControlOptions specifies a set of options for the map type control.

Fields Summary

• ALIGN_HORIZONTALLY
• ALIGN_VERTICALLY
• buttonAlignment
• buttonSize
• buttonSpacing
• buttonStyle
• position

Constructors Summary

• MapTypeControlOptions

Methods Summary

• toString

Constants

Properties

Constructors

MapTypeControlOptions(param?:Object)

Constructs an MapTypeControlOptions object, optionally initializing it from an object.

// Initialization object corresponding to the default set.
{ buttonSize: new Point(67, 19),
  buttonStyle: new ButtonStyle({
  });
  buttonSpacing: new Point(0, 0),
  buttonAlignment: MapTypeControlOptions.ALIGN_HORIZONTALLY,
  position: new ControlPosition(ControlPosition.ANCHOR_TOP_RIGHT, 10)
}

Instance Methods

toString(): String

Returns a String representation of this object.

Back to top

class OverviewMapControl

A OverviewMapControl shows a small map in the corner of the containing map and displays a rectangle representing the containing map viewport. The rectangle can be dragged, or the overview map can be dragged to update the viewport.

Implements

• IControl

Constructors Summary

• OverviewMapControl

Methods Summary

• clearWrapper
• getControlPosition
• getDisplayObject
• getSize
• initControlWithMap
• setControlPosition
• setSize

Constructors

OverviewMapControl(options?:OverviewMapControlOptions)

Constructs a OverviewMapControl object.

Instance Methods

clearWrapper(): void

Remove all event listeners and clear the wrapper.

getControlPosition(): ControlPosition

Retrieves the control position.

getDisplayObject(): DisplayObject

Retrieves the control's display object (often this would be the control object itself, but potentially be a different object if the control contains a sprite rather than extending it).

getSize(): Point

Retrieves the control's size.

initControlWithMap(map:IMap): void

Sets the instance of the map that this control operates on. Normally invoked from the call to Map.addControl().

setControlPosition(position:ControlPosition): void

Sets the control's position and updates its position on the map.

navigatorControl.setControlPosition(
    new ControlPosition(ControlPosition.ANCHOR_TOP_RIGHT, 2, 2));

setSize(newSize:Point): void

Changes the control's size.

Back to top

class OverviewMapControlOptions

Class OverviewMapControlOptions specifies a set of options for the overview map control.

Fields Summary

• controlStyle
• navigatorStyle
• padding
• position
• size

Constructors Summary

• OverviewMapControlOptions

Methods Summary

• toString

Properties

Constructors

OverviewMapControlOptions(param?:Object)

Constructs an OverviewMapControlOptions object, optionally initializing it from an object.

// Initialization object corresponding to the default set.
{ size: {
    x: 100,
    y: 100
  },
  padding: {
    x: 4,
    y: 4
  },
  controlStyle: {
    fillStyle: {
      color: Color.WHITE,
      alpha: 1.0
    },
    strokeStyle: {
      color: Color.BLACK,
      alpha: 1.0,
      thickness: 1.0
    },
    bevelStyle: BevelStyle.BEVEL_RAISED,
    bevelThickness: 2.0,
    bevelAlpha: 0.6,
    highlightColor: Color.WHITE,
    shadowColor: Color.BLACK
  },
  navigatorStyle: {
    fillStyle: {
      color: NAVIGATOR_COLOR,
      alpha: Alpha.PERCENT_20
    },
    strokeStyle: {
      thickness: 2,
      color: NAVIGATOR_COLOR,
      alpha: 1.0
    }
  },
  position: new ControlPosition(ControlPosition.ANCHOR_BOTTOM_RIGHT, 10)
}

Instance Methods

toString(): String

toString method.

Back to top

class PositionControl

A PositionControl contains a set of panning buttons to pan the map.

Implements

• IControl

Constructors Summary

• PositionControl

Methods Summary

• clearWrapper
• getControlPosition
• getDisplayObject
• getSize
• initControlWithMap
• setControlPosition

Constructors

PositionControl(options?:PositionControlOptions)

Constructs a PositionControl object.

Instance Methods

clearWrapper(): void

Remove all event listeners and clear the wrapper.

getControlPosition(): ControlPosition

Retrieves the control position.

getDisplayObject(): DisplayObject

Retrieves the control's display object (often this would be the control object itself, but potentially be a different object if the control contains a sprite rather than extending it).

getSize(): Point

Retrieves the control's size.

initControlWithMap(map:IMap): void

Sets the instance of the map that this control operates on. Normally invoked from the call to Map.addControl().

setControlPosition(position:ControlPosition): void

Sets the control's position and updates its position on the map.

navigatorControl.setControlPosition(
    new ControlPosition(ControlPosition.ANCHOR_TOP_RIGHT, 2, 2));

Back to top

class PositionControlOptions

Class PositionControlOptions specifies a set of options for the position control.

Fields Summary

• buttonSize
• buttonSpacing
• buttonStyle
• position

Constructors Summary

• PositionControlOptions

Methods Summary

• toString

Properties

Constructors

PositionControlOptions(param?:Object)

Constructs an PositionControlOptions object, optionally initializing it from an object.

// Initialization object corresponding to the default set.
{ buttonSize: new Point(17, 17),
  buttonStyle: new ButtonStyle({
  });
  buttonSpacing: new Point(4, 4),
  position: new ControlPosition(ControlPosition.ANCHOR_TOP_LEFT, 10)
}

Instance Methods

toString(): String

toString method. Returns a String representation of this object.

Back to top

class ScaleControl

A ScaleControl provides a control that shows the scale of the map.

Implements

• IControl

Constructors Summary

• ScaleControl

Methods Summary

• clearWrapper
• getControlPosition
• getDisplayObject
• getSize
• initControlWithMap
• setControlPosition

Constructors

ScaleControl(options?:ScaleControlOptions)

Constructs a ScaleControl object.

Instance Methods

clearWrapper(): void

Remove all event listeners and clear the wrapper.

getControlPosition(): ControlPosition

Retrieves the control position.

getDisplayObject(): DisplayObject

Retrieves the control's display object (often this would be the control object itself, but potentially be a different object if the control contains a sprite rather than extending it).

getSize(): Point

Retrieves the control's size.

initControlWithMap(map:IMap): void

Sets the instance of the map that this control operates on. Normally invoked from the call to Map.addControl().

setControlPosition(position:ControlPosition): void

Sets the control's position and updates its position on the map.

navigatorControl.setControlPosition(
    new ControlPosition(ControlPosition.ANCHOR_TOP_RIGHT, 2, 2));

Back to top

class ScaleControlOptions

Class ScaleControlOptions specifies a set of options for the scale control.

Fields Summary

• UNITS_BOTH
• UNITS_BOTH_PREFER_IMPERIAL
• UNITS_BOTH_PREFER_METRIC
• UNITS_IMPERIAL_ONLY
• UNITS_METRIC_ONLY
• UNITS_SINGLE
• labelFormat
• lineThickness
• maxWidth
• position
• units

Constructors Summary

• ScaleControlOptions

Methods Summary

• toString

Constants

Properties

Constructors

ScaleControlOptions(param?:Object)

Constructs an ScaleControlOptions object, optionally initializing it from an object.

// Initialization object corresponding to the default set.
{ position: new ControlPosition(ControlPosition.ANCHOR_BOTTOM_LEFT, 70, 5)
  units: ScaleControlOptions.UNITS_BOTH,
  maxWidth: 125,
  lineThickness: 1,
  labelFormat: {
    font: "_sans",
    size: 11
  }
}

Instance Methods

toString(): String

Returns a String representation of this object.

Back to top

class ZoomControl

A ZoomControl contains buttons for zooming the map in and out and a zoom slider.

Implements

• IControl

Constructors Summary

• ZoomControl

Methods Summary

• clearWrapper
• getControlPosition
• getDisplayObject
• getSize
• initControlWithMap
• setControlPosition

Constructors

ZoomControl(options?:ZoomControlOptions)

Constructs a ZoomControl object, with an optional options setting.

Instance Methods

clearWrapper(): void

Remove all event listeners and clear the wrapper.

getControlPosition(): ControlPosition

Retrieves the control position.

getDisplayObject(): DisplayObject

Retrieves the control's display object (often this would be the control object itself, but potentially be a different object if the control contains a sprite rather than extending it).

getSize(): Point

Retrieves the control's size.

initControlWithMap(map:IMap): void

Sets the instance of the map that this control operates on. Normally invoked from the call to Map.addControl().

setControlPosition(position:ControlPosition): void

Sets the control's position and updates its position on the map.

navigatorControl.setControlPosition(
    new ControlPosition(ControlPosition.ANCHOR_TOP_RIGHT, 2, 2));

Back to top

class ZoomControlOptions

Class ZoomControlOptions specifies a set of options for the zoom control.

Fields Summary

• buttonSize
• buttonSpacing
• buttonStyle
• hasScrollTrack
• position

Constructors Summary

• ZoomControlOptions

Methods Summary

• toString

Properties

Constructors

ZoomControlOptions(param?:Object)

Constructs an ZoomControlOptions object, optionally initializing it from an object.

// Initialization object corresponding to the default set.
{ buttonSize: new Point(17, 17),
  buttonStyle: new ButtonStyle({
    allStates: {
      bevelThickness: 1.5,
      bevelAlpha: 0.5
    }
  }),
  buttonSpacing: new Point(4, 4),
  hasScrollTrack: true,
  position: new ControlPosition(ControlPosition.ANCHOR_TOP_LEFT, 31, 76)
}

Instance Methods

toString(): String

Returns a String representation of this object.

Back to top

interface IClientGeocoder

IClientGeocoder is the interface implemented by client geocoder object. A client geocoder communicates with Google servers to obtain geocodes for user specified addresses. In addition, a geocoder maintains its own cache of addresses, which allows repeated queries to be answered without a round trip to the server.

Implementing Classes

• ClientGeocoder

Methods Summary

• geocode
• getOptions
• resetCache
• reverseGeocode
• setOptions

Instance Methods

geocode(address:String): void

Initiates a geocoding request. Dispatches GeocodingEvent.GEOCODING_SUCCESS or GeocodingEvent.GEOCODING_FAILURE on completion.

getOptions(): ClientGeocoderOptions

Retrieves the geocoder object's options. Use the setOptions() method to modify geocoder options.

resetCache(): void

Resets the geocoding cache, clearing all results retrieved by this and other ClientGeocoder objects.

reverseGeocode(latLng:LatLng): void

Initiates a reverse geocoding request. Dispatches GeocodingEvent.GEOCODING_SUCCESS or GeocodingEvent.GEOCODING_FAILURE on completion.

setOptions(options:ClientGeocoderOptions): void

Updates the geocoder options. The options parameter may specify a complete or partial set of geocoder options.

Back to top

interface IControl

This interface is implemented by map controls. You can implement this interface or use com.google.maps.controls.ControlBase class in order to provide a custom control for the map. Controls are added to the map using the Map.addControl() method.

Implementing Classes

• ControlBase
• MapTypeControl
• OverviewMapControl
• PositionControl
• ScaleControl
• ZoomControl

Methods Summary

• getControlPosition
• getDisplayObject
• getSize
• initControlWithMap
• setControlPosition

Instance Methods

getControlPosition(): ControlPosition

Retrieves the control position.

getDisplayObject(): DisplayObject

Retrieves the control's display object (often this would be the control object itself, but potentially be a different object if the control contains a sprite rather than extending it).

getSize(): Point

Retrieves the control's size.

initControlWithMap(map:IMap): void

Sets the instance of the map that this control operates on. Normally invoked from the call to Map.addControl().

setControlPosition(position:ControlPosition): void

Sets the control's position and updates its position on the map.

navigatorControl.setControlPosition(
    new ControlPosition(ControlPosition.ANCHOR_TOP_RIGHT, 2, 2));

Back to top

interface ICopyrightCollection

ICopyrightCollection is the interface implemented by CopyrightCollection and equivalent classes. CopyrightCollection manages copyright messages displayed on maps of custom map type. A copyright collection contains information about which copyright to display for which region on the map at which zoom level. This is very important for map types that display heterogenous data such as the satellite map type.

Implementing Classes

• CopyrightCollection

Methods Summary

• addCopyright
• getCopyrightNotice
• getCopyrights
• getCopyrightsAtLatLng

Instance Methods

addCopyright(copyright:Copyright): Boolean

Adds the given copyright to the collection, returning true if the copyright was new and was added or false if the copyright was a duplicate and ignored.

getCopyrightNotice(bounds:LatLngBounds, zoom:Number): CopyrightNotice

Returns a CopyrightNotice instance for the given viewport.

getCopyrights(bounds:LatLngBounds, zoom:Number): Array

Retrieves an array of elements of type String, which comprises the copyright text that we should display for the given viewport.

getCopyrightsAtLatLng(latLng:LatLng): Array

Returns an array of elements of type Copyright, which are the copyrights pertaining to the specified location.

Back to top

interface IDirections

IDirections is the interface implemented by a Directions object. A Directions object communicates with Google servers to obtain directions between two or more waypoints. Responses to such requests contain an encoded polyline representing the directions, and HTML-formatted steps to take.

Implementing Classes

• Directions

Fields Summary

• bounds
• copyrightsHtml
• distance
• distanceHtml
• duration
• durationHtml
• numGeocodes
• numRoutes
• status
• summaryHtml

Methods Summary

• clear
• createPolyline
• getGeocode
• getOptions
• getRoute
• load
• setOptions

Properties

Instance Methods

clear(): void

Clears any existing directions results and cancels any pending load() requests.

createPolyline(options?:PolylineOptions): IPolyline

Create the Polyline object associated with the entire directions response. Note that there is a single polyline that represents all routes in the response. This object can be created only after the directions results have been loaded (i.e. the "load" event has been triggered).

getGeocode(i:uint): Placemark

Return the geocoded result for the ith waypoint.

getOptions(): DirectionsOptions

Retrieves the directions object's options. Use the setOptions() method to modify directions object's options.

getRoute(i:uint): Route

Return the Route object for the ith route in the response.

load(query:String): void

Initiates a directions request. Dispatches either DirectionsEvent.DIRECTIONS_SUCCESS, DirectionsEvent.DIRECTIONS_FAILURE, or DirectionsEvent.DIRECTIONS_ABORTED on completion. Each event serves as a notification that the directions response has come back from the server, and in the case of the success event, the response information can be retrieved from this object. When directions results are received, this object clears old results, replacing them with new ones. Directions results consist of multiple routes, one per consecutive pair of waypoints/addresses specified in the query. In turn, routes consist of multiple steps. If a previous load() request has not completed when a new call to load() is invoked, the previous request is cancelled and a DirectionsEvent.DIRECTIONS_ABORTED event will be dispatched for that request. Thus, you can use a single Directions object to issue directions requests serially, but to generate multiple requests in parallel, you must use multiple Directions objects.

setOptions(options:DirectionsOptions): void

Updates the directions options. The options parameter may specify a complete or partial set of directions options.

Back to top

interface IGroundOverlay

IGroundOverlay is the interface implemented by ground overlay objects. Ground overlays are images laid out over the map content whose corners are located with latitude/longitude pairs.

Implementing Classes

• GroundOverlay

Methods Summary

• getOptions
• setOptions

Instance Methods

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.

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.

// Modify the ground overlay's stroke colour, leaving the rest
// of its options unchanged.
var options:GroundOverlayOptions =
    new GroundOverlayOptions( { strokeStyle: { color: 0x000080 }} );
myGroundOverlay.setOptions(options);

Back to top

interface IInfoWindow

IInfoWindow is the interface implemented by information windows that can display HTML-formatted text.

Fields Summary

• removed

Properties

Back to top

interface IMap

IMap is the interface implemented by Map. Create an instance of class Map to create a map. This is the central class in the API.

Implementing Classes

• Map
• MapType

Fields Summary

• MERCATOR_PROJECTION
• overlayRaising

Methods Summary

• addControl
• addMapType
• addOverlay
• clearControls
• clearOverlays
• closeInfoWindow
• continuousZoomEnabled
• controlByKeyboardEnabled
• crosshairsEnabled
• disableContinuousZoom
• disableControlByKeyboard
• disableCrosshairs
• disableDragging
• disableScrollWheelZoom
• draggingEnabled
• enableContinuousZoom
• enableControlByKeyboard
• enableCrosshairs
• enableDragging
• enableScrollWheelZoom
• fromLatLngToPoint
• fromLatLngToViewport
• fromPointToLatLng
• fromViewportToLatLng
• getBoundsZoomLevel
• getCenter
• getCurrentMapType
• getDisplayObject
• getDoubleClickMode
• getImplementationVersion
• getLatLngBounds
• getMapTypes
• getMaxZoomLevel
• getMinZoomLevel
• getOptions
• getPaneManager
• getProjection
• getSize
• getZoom
• isLoaded
• openInfoWindow
• panBy
• panTo
• removeControl
• removeMapType
• removeOverlay
• returnToSavedPosition
• savePosition
• scrollWheelZoomEnabled
• setCenter
• setDoubleClickMode
• setMapType
• setSize
• setZoom
• unload
• zoomIn
• zoomOut

Properties

Instance Methods

addControl(control:IControl): void

Registers a new control. This can be called before the MAP_READY event has been received.

public class MyMap extends Map {
  public function MyMap() {
    super();
    addEventListener(MapEvent.MAP_READY, onMapReady);
    addControl(new MapTypeControl());
  }
}

addMapType(newMapType:IMapType): void

Registers a new map type.

addOverlay(overlay:IOverlay): void

Adds an overlay to the map.

var marker:Marker = new Marker(
    new LatLng(48.858842, 2.346997),
    new MarkerOptions({ fillRGB: 0x004000,
                        name: "Paris, France",
                        description: "City on the Seine" }));
map.addOverlay(marker);

clearControls(): void

Removes all controls from the map.

clearOverlays(): void

Removes all overlays from the map.

closeInfoWindow(): Boolean

Closes the information window.

continuousZoomEnabled(): Boolean

Checks whether continuous zoom is enabled.

controlByKeyboardEnabled(): Boolean

Checks whether control by keyboard is enabled.

crosshairsEnabled(): Boolean

Checks whether center crosshairs are enabled.

disableContinuousZoom(): void

Disables continuous smooth zooming.

disableControlByKeyboard(): void

Disables control by keyboard.

disableCrosshairs(): void

Disables the center crosshairs.

disableDragging(): void

Disables dragging of the map.

disableScrollWheelZoom(): void

Disables zooming using a mouse's scroll wheel.

draggingEnabled(): Boolean

Checks whether dragging of the map is enabled.

enableContinuousZoom(): void

Enables continuous smooth zooming.

enableControlByKeyboard(): void

Enables control by keyboard.

enableCrosshairs(): void

Enables the center crosshairs.

enableDragging(): void

Enables dragging of the map.

enableScrollWheelZoom(): void

Enables zooming using a mouse's scroll wheel.

fromLatLngToPoint(latLng:LatLng, opt_zoom?:Number): Point

Returns x,y coordinates of specified lat, lng and zoom relative to the origin of the map's projection (the origin is the top left corner of the top left tile of the map for the specified map zoom level).

fromLatLngToViewport(latLng:LatLng, opt_disablewrap?:Boolean): Point

Returns the pixel coordinates for the specified latLng location in the coordinate system of the map's view port ([0,0] being the top left corner of the map object).

fromPointToLatLng(pos:Point, opt_zoom?:Number, opt_nowrap?:Boolean): LatLng

Returns lat,lng coordinates of specified x, y and zoom. The coordinates are relative to the origin of the map's projection (the top left corner of the top left tile of the map for the specified zoom level).

fromViewportToLatLng(pos:Point, opt_nowrap?:Boolean): LatLng

Returns the lat-lng of the point at the given coordinates in the map's view port (the top left corner of the map object).

getBoundsZoomLevel(bounds:LatLngBounds): Number

Returns the highest resolution zoom level at which the given rectangular region fits in the map view. The zoom level is computed for the currently selected map type.

getCenter(): LatLng

Retrieves coordinates of the center in the map view control.

getCurrentMapType(): IMapType

Retrieves the current map type.

getDisplayObject(): DisplayObject

Retrieves the display object that represents the map.

getDoubleClickMode(): Number

Get the mouse double click mode.

getImplementationVersion(): String

Gets the version of the implementation library SWF.

getLatLngBounds(): LatLngBounds

Returns the the visible rectangular region of the map view in geographical coordinates.

getMapTypes(): Array

Retrieves the list of the map types available for the location.

getMaxZoomLevel(opt_mapType?:IMapType, opt_point?:LatLng): Number

Retrieves the maximum zoom level.

getMinZoomLevel(opt_mapType?:IMapType, opt_point?:LatLng): Number

Retrieves the minimum zoom level.

getOptions(): MapOptions

Retrieves the full set of options used by the map. Note that since MapOptions is used only during map initialization, this method only allows those original settings to be retrieved and does not support re-configuration of the map.

getPaneManager(): IPaneManager

Retrieves the pane manager for the map.

getProjection(): IProjection

Returns the projection being applied to the map.

getSize(): Point

Retrieves the map view size.

getZoom(): Number

Retrieves the map zoom level.

isLoaded(): Boolean

Checks whether the map has been initialized.

openInfoWindow(latlng:LatLng, options?:InfoWindowOptions): IInfoWindow

Opens a simple information window at the given point.

panBy(distance:Point): void

Starts a pan animation by the given distance in pixels.

panTo(latLng:LatLng): void

Pans the map to the specified centre location.

removeControl(control:IControl): void

Removes a control from the map. If the control was not added to the map, this does nothing.

removeMapType(oldMapType:IMapType): void

Removes a registered map type.

removeOverlay(overlay:IOverlay): void

Removes an overlay from the map.

returnToSavedPosition(): void

Returns map to the saved position.

savePosition(): void

Stores the current map position and zoom level for later recall by returnToSavedPosition.

scrollWheelZoomEnabled(): Boolean

Checks whether scroll wheel zooming is enabled.

setCenter(latLng:LatLng, opt_zoom?:Number, opt_mapType?:IMapType): void

Changes the centre point of the map.

setDoubleClickMode(val:Number): void

Set the mouse double click mode.

setMapType(mapType:IMapType): void

Changes the map type for the map.

setSize(newSize:Point): void

Sets the size of the map view.

setZoom(level:Number, opt_doContinuousZoom?:Boolean): void

Changes the zoom level for the map view control.

unload(): void

Removes the map from its parent and attempts to unload it to free up memory associated with the map. The map object will no longer be usable after the call to this method.

zoomIn(opt_latlng?:LatLng, opt_doCenter?:Boolean, opt_doContinuousZoom?:Boolean): void

Zooms in the map by one zoom level if possible.

zoomOut(opt_latlng?:LatLng, opt_doContinuousZoom?:Boolean): void

Zooms out the map by one zoom level if possible.

Back to top

interface IMapType

IMapType is the interface implemented by map type objects. A map type is a set of tile layers, a map projection, a tile size, and assorted other settings, such as link colors and copyrights. Google provides a set of predefined map types. You can also use com.google.maps.MapType class to define a custom map type. Map types can be added to the map using the Map.addMapType() method.

Implementing Classes

• MapType

Methods Summary

• getAlt
• getBoundsZoomLevel
• getCopyrights
• getErrorMessage
• getLinkColor
• getMaxResolutionOverride
• getMaximumResolution
• getMinimumResolution
• getName
• getProjection
• getRadius
• getSpanZoomLevel
• getTextColor
• getTileLayers
• getTileSize
• getUrlArg
• setMaxResolutionOverride

Instance Methods

getAlt(): String

Returns the text of the hint that is displayed when the user hovers over a control that allows selection of this map type. MapTypeControl is such a control.

getBoundsZoomLevel(bounds:LatLngBounds, viewSize:Point): Number

Returns the highest resolution zoom level required to show the given lat/lng bounds in a map of the given pixel size.

getCopyrights(bounds:LatLngBounds, zoom:Number): Array

Returns an array of copyright notices for the given bounds and zoom level. Each element in this array is of type CopyrightNotice.

getErrorMessage(): String

Returns the text to be displayed if a tile fails to download.

getLinkColor(): Number

If a control displays a link above the map, returns the color we should use. The "terms of use" link in the copyright control uses this color, for example.

getMaxResolutionOverride(): Number

Returns the max resolution override.

getMaximumResolution(opt_point?:LatLng): Number

Returns the zoom level of the maximum resolution supported by this map type. If opt_point is given, returns the maximum resolution at the given lat/lng. If opt_point is not given, returns the global maximum.

getMinimumResolution(opt_point?:LatLng): Number

Returns the zoom level of the minimum resolution supported by this map type. If opt_point is given, returns the minimum resolution at the given lat/lng. If opt_point is not given, returns the global minimum.

getName(opt_short?:Boolean): String

Retrieves the map type name.

getProjection(): IProjection

Retrieves the map type projection.

getRadius(): Number

Returns the radius of the planet for which this map type is defined.

getSpanZoomLevel(center:LatLng, span:LatLng, viewSize:Point): Number

Returns the highest resolution zoom level required to show the given lat/lng span with the given center point.

getTextColor(): Number

If controls are textual, returns the appropriate color to display the text. The copyright control uses this color, for example.

getTileLayers(): Array

Gets the list of tile layers for this map type.

getTileSize(): Number

Gets the tile size for this map type. The predefined map types' tiles are all 256 by 256 pixels in size: this function would, for these map types, return 256.

getUrlArg(): String

Returns a string that may be used as a URL parameter to identify this map type in permalinks to the current map view. This is currently only used by the maps application.

setMaxResolutionOverride(maxResolution:Number): void

Sets the max resolution override, such that, if this number is greater than the max resolution that our map type reports to us, we will use this number instead. It represents the number of levels shown on the ZoomControl's scrollbar.

Back to top

interface IMarker

IMarker is the interface implemented by marker objects to mark position on that map. Markers can be added to the map using the Map.addOverlay() method.

Implementing Classes

• Marker

Methods Summary

• closeInfoWindow
• getLatLng
• getOptions
• openInfoWindow
• setLatLng
• setOptions

Instance Methods

closeInfoWindow(): void

Closes the info window if it is associated with this marker.

getLatLng(): LatLng

Retrieves the location of the marker.

getOptions(): MarkerOptions

Retrieves the full set of options used by the marker. Use the setOptions method to modify the options on the marker.

openInfoWindow(options?:InfoWindowOptions): IInfoWindow

Opens an information window above the marker.

setLatLng(value:LatLng): void

Changes the LatLng of the marker.

setOptions(options:MarkerOptions): void

Updates the marker options. The options parameter may specify a complete or partial set of marker 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.

// Modify the marker's fill colour, leaving the rest
// of its options unchanged.
var options:MarkerOptions =
    new MarkerOptions( { fillStyle: { color: 0x000080 }} );
myMarker.setOptions(options);

Back to top

interface IOverlay

This interface is implemented by the overlay objects, such as markers, polylines, polygons, ground overlays and info windows. An instance of IOverlay can be put on the map with the method Map.addOverlay().

Implementing Classes

• OverlayBase

Fields Summary

• foreground
• pane
• shadow
• visible

Methods Summary

• getDefaultPane
• positionOverlay

Properties

Instance Methods

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).

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).

Back to top

interface IPane

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

Fields Summary

• id
• map
• paneManager
• visible

Methods Summary

• addOverlay
• bringToTop
• clear
• fromLatLngToPaneCoords
• fromPaneCoordsToLatLng
• fromPaneCoordsToProjectionPoint
• fromProjectionPointToPaneCoords
• getViewportBounds
• invalidate
• removeOverlay
• updatePosition

Properties

Instance Methods

addOverlay(overlay:IOverlay): void

Adds an overlay to the pane.

bringToTop(overlay:IOverlay): void

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

clear(): void

Removes all overlays added to this pane.

fromLatLngToPaneCoords(latLng:LatLng, closestToCenter?:Boolean): 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.

fromPaneCoordsToLatLng(point:Point, opt_nowrap?:Boolean): 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.

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).

fromProjectionPointToPaneCoords(projectionPoint:Point): Point

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

getViewportBounds(): Rectangle

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

invalidate(): void

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

removeOverlay(overlay:IOverlay): void

Removes an overlay from the pane.

updatePosition(force?:Boolean): void

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

Back to top

interface IPaneManager

Interface to the Pane manager of the map. Pane manager is responsible for creating/removing/transposing overlay panes on the map.

Fields Summary

• map
• paneCount

Methods Summary

• clearOverlays
• containsPane
• createPane
• getPaneAt
• getPaneById
• getPaneIndex
• placePaneAt
• removeAllPanes
• removePane

Properties

Instance Methods

clearOverlays(): void

Removes all overlays registered on all panes.

containsPane(pane:IPane): Boolean

Checks whether the pane manager contains the specified pane.

createPane(index?:int): IPane

Creates a new pane and adds it at the specified position.

getPaneAt(index:int): IPane

Retrieves the pane by its relative position.

getPaneById(paneId:int): IPane

Retrieves the pane by the pane's id.