G Map V. 2.7 Documentation
Properties
| Name | Type | Description |
| centerCross | Boolean | Defines whether the center cross is displayed (true) or not (false). Example gMap.centerCross = true; |
| centerCrossColor | Number | A Hexadecimal color value. Example gMap.centerCross = true; gMap.centerCrossColor = 0xFF0000; |
| animatePan | Boolean | Determines whether pan is animated. Example gMap.animatePan = true; |
| panSpeed | Number | Indicates how fast the pan animation is. Example gMap.panSpeed = 3; |
| animateZoom | Boolean | Determines whether zoom is animated. Example gMap.animateZoom = false; |
| controlByKeyboard | Boolean | Enables zoom and control with the keyboard. Example gMap.controlByKeyboard = true; |
| controlByMouse | Boolean | Enables mouse controls. Property overrides controlByMouseWheel. Example gMap.controlByMouse = false; |
| controlByMouseWheel | Boolean | Enables mouse wheel zooming. Please note that controlByMouse has to be set to true. Example gMap.controlByMouse = true; gMap.controlByMouseWheel = true; |
| doubleClickMode | String | Defines map behavior on Mouse Double Click event. Options
gMap.doubleClickMode ="zoom"; |
| latitude | Number | Defines initial latitude. Example gMap.latitude = 50; |
| longitude | Number | Defines initial longitude. Example gMap.longitude = -50; |
| mapType | String | Property defines displayed map type Options
function eventResponder(event:Object){ event.target.mapType = "satellite" } gMap.addEventListener("MAP_READY", eventResponder); |
| zoom | Number | Defines initial zoom level. Example gMap.zoom = 3; |
| zoomAtPointer | Boolean | If set to true, the map will zoom on the point where the mouse cursor is when zooming with the mouse wheel. Example gMap.zoomAtPointer = true; |
Methods
| Name | Return Type | Description |
| getCenter( ) | Object | Returns center object that contains lat,lng coordinates.
Example var center = gMap.getCenter(); trace(center.lat); //Latitude trace(center.lng); //Longitude |
| setCenter( {lat:Number, lng:Number}, [zoom:Number] ) |
Void | Sets map center. Example gMap.setCenter({lat:39, lng:-104},10); |
| getBounds( ) | Object | Returns bounds rectangle. Example var bounds = map.getBounds(); |
| setBounds( {RectangeObject:Object} ) | Void | Set the map to the center of a rectangle specified by a rectangle object. Example map.setBounds(map.GBounds(left,top,right,bottom)) |
| zoomIn( [level:Number] ) | Void | Increases zoom level to the next level or to a specified value. Example map.zoomIn(); |
| zoomOut( [level:Number] ) | Void | Decreases zoom level to the previous level or to a specified value. Example map.zoomOut(); |
| savePosition( ) | Void | Stores current map position for later recall returnToSavedPosition();. Example map.savePosition(); |
| getSavedPosition( ) | Object | Returns saved position object.
Example var position = map.getSavedPosition(); trace(position.lat); trace(position.lng); trace(position.zoom); |
| returnToSavedPosition( ) | Void | Returns to the saved position if savedPosition is defined, otherwise returns to the default position. Example map.returnToSavedPosition(); |
| returnToDefaultPosition( ) | Void | Returns to default position. Triggered whenever center button is clicked in the expanded control. Example map.returnToDefaultPosition(); |
| panTo( {lat:Number,lng:Number} ) | Void | Changes the center point of the map to the given point. If the point is already visible in the current map view, change the center in a smooth animation. Example import com.google.GMap.types.GLocation; map.panTo(new GLocation(39, -104)); |
| panBy( {lat:Number, lng:Number} ) |
Void | Starts a pan animation by the given distance in pixels. Example map.panBy(39,-104); |
| panByXY( {x:Number, y:Number} ) |
Void | Starts a pan animation by the given distance in X Y coordinates. Example map.panByXY(10,20); |
| moveNorth( [distance:Number] ) | Void | Moves north. If distance argument is set moves to a specified distance in pixels. Example map.moveNorth(); |
| moveEast( [distance:Number] ) | Void | Moves east. If distance argument is set moves to a specified distance in pixels. Example map.moveEast(); |
| moveSouth( [distance:Number] ) | Void | Moves south. If distance argument is set moves to a specified distance in pixels. Example map.moveSouth(); |
| moveWest( [distance:Number] ) | Void | Moves west. If distance argument is set moves to a specified distance in pixels. Example map.moveWest(); |
| getMapTypes( ) | Array | Returns array of map types (Map, Satellite, Hybrid). Example var types:Array = map.getMapTypes(); trace(type); |
| setMapType( type:String ) | Void | Sets map display to a specified map type.
Example map.setMapType("map"); |
| getSelectedMapType( ) | String | Returns currently displayed map type. Example var selectedMap = map.getSelectedMapType(); trace(selectedMap); |
| addControl( {control:Object} ) | Void | Adds controls. Map Type Control map.addControl(map.GTypeControl()); Zoom Control map.addControl(map.GZoomControl()); Position Control map.addControl(map.GPositionControl()); |
| addPoint( {point:Object} ) | GPoint | Adds GPoint to the map. Example var myPoint = map.addPoint({lat:39.74002, lng:-104.992261, name:"Denver"}); |
| getPoint( [id:Number,name:String] ) | GPoint | Returns specified GPoint object. Example var point = map.getPoint(5); trace(point); |
| addLine( {Line:Object} ) | GLine | Adds a line. ActionScript Example var linePoints:Array = new Array(); linePoints.push({lat:39.740038,lng:-104.992272}); linePoints.push({lat:25.728989,lng:-80.237446}); var myLine = gMap.addLine({points:linePoints}); |
| getLine( [id:Number,name:String] ) | GLine | Returns specified GLine object. ActionScript Example var linePoints:Array = new Array(); linePoints.push({lat:39.740038,lng:-104.992272}); linePoints.push({lat:25.728989,lng:-80.237446}); gMap.addLine({points:linePoints,name:"My Line"}); var line = gMap.getLine("My Line"); trace(line.name); |
| addPolygon( {Polygon:Object} ) | GPolygon | Adds a polygon. ActionScript Example var shape:Array = new Array(); shape.push({lat:50,lng:-100}); shape.push({lat:-50,lng:-100}); shape.push({lat:-50,lng:100}); shape.push({lat:50,lng:100}); var myPolygon = gMap.addPolygon({points:shape}); |
| getPolygon( [id:Number,name:String] ) | GPolygon | Returns specified GPolygon object. ActionScript Example var shape:Array = new Array(); shape.push({lat:50,lng:-100}); shape.push({lat:-50,lng:-100}); shape.push({lat:-50,lng:100}); shape.push({lat:50,lng:100}); gMap.addPolygon({points:shape, name:"My Polygon"}); var polygon = gMap.getPolygon("My Polygon"); trace(polygon.name); |
| addOverlay( {Overlay:Object} ) | GOverlay | Adds a image overlay. ActionScript Example var myOverlay = gMap.addOverlay({path:"image.gif", north:50, west:-100, south:-50, east:100}); |
| getOverlay( [id:Number,name:String] ) | GOverlay | Returns specified GOverlay object. ActionScript Example gMap.addOverlay({name:"My Overlay", path:"image.gif", north:50, west:-100, south:-50, east:100}); var overlay = gMap.getOverlay(); trace(overlay.name); |
| addKMLLayer( {KMLLayer:Object} ) | KMLLayer | Adds a new KML Layer. ActionScript Example gMap.addKMLLayer({path:"file.kml"}); Note: Layer methods (such as removeLayer()) will work for the KMLLayer object. |
| addLayer( {layer:Object} ) | GLayer | Adds a new layer object to the map. Example var layer = {name:"locations"}; var myLayer = map.addLayer(layer); |
| getLayer( [id:Number, name:String] ) |
GLayer | Returns a layer object specified by id argument or an Array of layer objects that match name parameter. Example var result = map.getLayer("myLayer"); trace(result); |
| removeLayer( {layer:Object} ) | Void | Removes layer object form the map. Example removeLayer(layer); |
| removeLayers( ) | Void | Removes all layers from the map except for the default layer. ActionScript Example gMap.removeLayers(); |
Events
| Name | Return Value | Description |
| MAP_READY | type target |
Triggered after marker object has been initiated. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_READY", this.evntResponder); |
| MAP_ERROR | type target message |
Triggered whenever error within the component occurs. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ERROR", this.evntResponder); |
| MAP_COPYRIGHT_CHANGED | type target copyright:Array copyrightNotice:Array bounds:GBounds zoom:Number |
Triggered whenever copyright notice is updated. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_COPYRIGHT_CHANGED", this.evntResponder); |
| MAP_POSITION_CHANGED | type target newLat:Number newLng:Number oldLat:Number oldLng:Number |
Triggered whenever map location is changed. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_POSITION_CHANGED", this.evntResponder); |
| MAP_ZOOM_CHANGED | type target oldZoom:Number newZoom:Number |
Triggered whenever map zoom value is changed. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ZOOM_CHANGED", this.evntResponder); |
| MAP_TYPE_CHANGED | type target |
Triggered whenever map type is changed. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_TYPE_CHANGED", this.evntResponder); |
| MAP_ON_DRAG | type target |
Triggered whenever map is dragged. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ON_DRAG", this.evntResponder); |
| MAP_ON_DRAG_START | type target |
Triggered whenever map dragging starts. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ON_DRAG_START", this.evntResponder); |
| MAP_ON_DRAG_STOP | type target |
Triggered whenever map dragging stops. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ON_DRAG_STOP", this.evntResponder); |
| MAP_ON_ROLL_OVER | type target lat:Number lng:Number |
Triggered onRollOver mouse event. Returns coordinates of the clicked point. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ON_ROLL_OVER", this.evntResponder); |
| MAP_ON_ROLL_OUT | type target lat:Number lng:Number |
Triggered onRollOut mouse event. Returns coordinates of the clicked point. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ON_ROLL_OUT", this.evntResponder); |
| MAP_ON_RELEASE | type target lat:Number lng:Number |
Triggered onRelease mouse event. Returns coordinates of clicked point. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ON_RELEASE", this.evntResponder); |
| MAP_ON_PRESS | type target lat:Number lng:Number |
Triggered onPress mouse event. Returns coordinates of the clicked point. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ON_PRESS", this.evntResponder); |
| MAP_ON_RELEASE_OUTSIDE | type target |
Triggered onReleaseOutside mouse event. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_ON_RELEASE_OUTSIDE", this.evntResponder); |
| MAP_CLICK | type target lat:Number lng:Number |
Triggered onMouseDown mouse event. Returns coordinates of the clicked point. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_CLICK", this.evntResponder); |
| MAP_ON_DBL_CLICK | type target lat:Number lng:Number |
Triggered whenever mouse is double clicked. Returns coordinates of the clicked point. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_DBL_CLICK", this.evntResponder); |
| MAP_LOAD_START | type target |
Triggered when map loading starts. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_LOAD_START", this.evntResponder); |
| MAP_LOAD_PROGRESS | type target totalTiles:Number currentTile:Number |
Triggered during loading of the map tiles. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_LOAD_PROGRESS", this.evntResponder); |
| MAP_LOAD_COMPLETE | type target |
Triggered whenever tile loading is complete. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_LOAD_COMPLETE", this.evntResponder); |
| MAP_PAN | type target lat:Number lng:Number |
Triggered whenever panBy() or panTo() methods are called. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_PAN", this.evntResponder); |
| MAP_PAN_START | type target lat:Number lng:Number |
Triggered when pan starts. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_PAN_START", this.evntResponder); |
| MAP_PAN_STOP | type target tal:Number lng:Number |
Triggered when pan ends. Example evntResponder = function (evnt:Object){ trace(evnt.type); } map.addEventListener("MAP_PAN_STOP", this.evntResponder); |
