Google Maps API Tutorial

Unofficial Reference

See also the Official Google Maps API Documentation

GAddCopyright GAddMessages GAdsManager GBounds GBrowserIsCompatible GClientGeocoder GControl GControlPosition GCopyright GCopyrightCollection GDirections GDownloadUrl GDraggableObject GEvent GFactualGeocodeCache GGeoXml GGeocodeCache GGroundOverlay GHierarchicalMapTypeControl GIcon GInfoWindow GInfoWindowTab GKeyboardHandler GLargeMapControl GLargeMapControl3D GLatLng GLatLngBounds GLayer GLoad GLoadMapsScript GLog GMap GMap2 GMapType GMapTypeControl GMapUIOptions GMarker GMarkerManager GMenuMapTypeControl

GMercatorProjection GNavLabelControl GOverlay GOverviewMapControl GPoint GPolygon GPolyline GProjection GRoute GScaleControl GScreenOverlay GScreenPoint GScreenSize GScript GSize GSmallMapControl GSmallZoomControl GSmallZoomControl3D GStep GStreetviewClient GStreetviewOverlay GStreetviewPanorama GTileLayer GTileLayerOverlay GTrafficOverlay GUnload GUnloadApi GValidateKey GVerify GXml GXmlHttp GXslt G_ANCHOR_BOTTOM_LEFT G_ANCHOR_BOTTOM_RIGHT G_ANCHOR_TOP_LEFT G_ANCHOR_TOP_RIGHT G_API_VERSION G_DEFAULT_ICON G_DEFAULT_MAP_TYPES

G_GEO_BAD_KEY G_GEO_MISSING_ADDRESS G_GEO_SERVER_ERROR G_GEO_SUCCESS G_GEO_TOO_MANY_QUERIES G_GEO_UNAVAILABLE_ADDRESS G_GEO_UNKNOWN_ADDRESS G_GOOGLEBAR_LINK_TARGET_BLANK G_GOOGLEBAR_LINK_TARGET_PARENT G_GOOGLEBAR_LINK_TARGET_SELF G_GOOGLEBAR_LINK_TARGET_TOP G_GOOGLEBAR_RESULT_LIST_INLINE G_GOOGLEBAR_RESULT_LIST_SUPPRESS G_HYBRID_MAP G_MAPMAKER_HYBRID_MAP G_MAPMAKER_MAP_TYPES G_MAPMAKER_NORMAL_MAP G_MAP_FLOAT_PANE G_MAP_FLOAT_SHADOW_PANE G_MAP_MAP_PANE G_MAP_MARKER_MOUSE_TARGET_PANE G_MAP_MARKER_PANE G_MAP_MARKER_SHADOW_PANE G_MAP_OVERLAY_LAYER_PANE G_MARS_ELEVATION_MAP G_MARS_INFRARED_MAP G_MARS_MAP_TYPES G_MARS_VISIBLE_MAP G_MOON_ELEVATION_MAP G_MOON_MAP_TYPES G_MOON_VISIBLE_MAP G_NORMAL_MAP G_PHYSICAL_MAP G_SATELLITE_3D_MAP G_SATELLITE_MAP G_SKY_MAP_TYPES G_SKY_VISIBLE_MAP G_TRAVEL_MODE_DRIVING G_TRAVEL_MODE_WALKING

G_ANCHOR_BOTTOM_LEFT

G_ANCHOR_BOTTOM_RIGHT

G_ANCHOR_TOP_LEFT

G_ANCHOR_TOP_RIGHT

G_API_VERSION

G_DEFAULT_ICON

G_DEFAULT_MAP_TYPES

G_GEO_BAD_KEY

G_GEO_MISSING_ADDRESS

G_GEO_SERVER_ERROR

G_GEO_SUCCESS

G_GEO_TOO_MANY_QUERIES

G_GEO_UNAVAILABLE_ADDRESS

G_GEO_UNKNOWN_ADDRESS

G_GOOGLEBAR_LINK_TARGET_BLANK

G_GOOGLEBAR_LINK_TARGET_PARENT

G_GOOGLEBAR_LINK_TARGET_SELF

G_GOOGLEBAR_LINK_TARGET_TOP

G_GOOGLEBAR_RESULT_LIST_INLINE

G_GOOGLEBAR_RESULT_LIST_SUPPRESS

G_HYBRID_MAP

G_MAPMAKER_MAP_TYPES

G_MAPMAKER_NORMAL_MAP

G_MAPMAKER_HYBRID_MAP

G_MAP_FLOAT_PANE

G_MAP_FLOAT_SHADOW_PANE

G_MAP_MAP_PANE

G_MAP_MARKER_MOUSE_TARGET_PANE

G_MAP_MARKER_PANE

G_MAP_MARKER_SHADOW_PANE

G_MAP_OVERLAY_LAYER_PANE

G_MARS_ELEVATION_MAP

G_MARS_INFRARED_MAP

G_MARS_MAP_TYPES

G_MARS_VISIBLE_MAP

G_MOON_ELEVATION_MAP

G_MOON_MAP_TYPES

G_MOON_VISIBLE_MAP

G_NORMAL_MAP

G_PHYSICAL_MAP

G_SATELLITE_3D_MAP

The Google Earth Map Type requires the Google Earth Browser Plug-In.

Only a limited number of features are supported in this map type.

G_SATELLITE_MAP

G_SKY_MAP_TYPES

G_SKY_VISIBLE_MAP

G_TRAVEL_MODE_DRIVING

G_TRAVEL_MODE_WALKING

GAddCopyright()

parameters

a	string	the getUrlArg() of the maptype to which the copyright applies.
b	string	id
c	float	min latitude
d	float	min longitude
e	float	max latitude
f	float	max longitude
g	integer	min zoom level
h	string	copyright text
i	integer	max zoom level
j	boolean	I'm not sure what this does

GAddMessages()

parameters

a

object

An object specifying the list of messages.

For example:
GAddMessages({10093:'Conditions d\x27utilisation',10507:'Déplacer vers la gauche'});
replaces the texts "Terms of Use" and "Pan Left" with their French equivalents.

GAdsManager()

parameters

map	the map on which the ads are to be displayed.
AdSense Id	Publisher id of your AdSense account
opts	options

options

maxAdsOnMap	Maximum number of ads to be displayed: default = 3.
channel	AdSense channel, can be used to track ad revenue.
minZoomLevel	Minimum zoom level for ad display: default = 6.

Methods

enable()	Enables ad display.
disable()	Disables ad display.

GBounds()

Constructor new GBounds(array)
An array of GPoint()s or GLatLng()s. The GBounds object that just includes those points is created.
properties

minX	Coordinate of the West edge
maxX	Coordinate of the East edge
minY	Coordinate of the South edge
maxY	Coordinate of the North edge

Methods

containsBounds(bounds)	Returns true if it fully contains the other bounds
containsPoint(gpoint)	Returns true if it contains the GPoint
copy()	undocumented Returns a new GBounds that is a copy of this one.
equals(bounds)	returns true if the two GBounds are equal
extend(point)	Enlarges the bounds to be the smallest rectangle containing the previous area plus the specified location
toString()	Returns a string in the format ((33.123, -120.123), (45.123, -100.234)).
max()	Returns a GPoint() representing the Northeast corner.
min()	Returns a GPoint() representing the SouthWest corner.
mid()	Returns a GPoint() representing the centre.

Static Methods

GBounds().intersection(bounds,bounds)	undocumented Returns a new GBounds representing the intersection of the two supplied GBounds
GBounds().intersects(bounds,bounds)	undocumented Returns true if the two GBounds intersect.

GBrowserIsCompatible()

So by calling GBrowserIsCompatible(true) you can have different CSS behaviour depending on the browser, simply by writing different CSS styles for .opera, .netscape etc. The known compatible agent names are "opera", "msie", "safari", "firefox", "netscape" and "mozilla". If another browser happens to pass the compatibility tests (by supporting regExp and DOM, and not being a known incompatible browser) then you get whatever it uses as its agent name.

GClientGeocoder

Constructor new GClientGeocoder(gcache, key, client, channel). The parameters are optional.

If the first parameter is present it specifies the GGeocodeCache or GFactualGeocodeCache to be used. If omitted, a new GFactualGeocodeCache is created.

If the second parameter is present it specifies a key to be used for geocoding. This key is only used if the API code itself was loaded without a key.

Methods

getAddresses(glatlng,callback)	undocumetned Sends a reverse geocode request to the server. Returns a structure similar to that returned by .getLocations(). If the request fails, it returns a structure containing an error code. (Now that the server is switched on, this works in versions from v2.98)
getAddressInBounds(glatlngbounds,callback)	undocumetned Sends a reverse geocode request to the server. Returns a structure similar to that returned by .getLocations(), but containing a single Placemark. Presumably the Placemark that best fits the size of the bounds of those returned by a reverse geocode request on the bounds centre.
getCache()	Returns a reference to the cache being used.
getLatLng(address,function)	Passes a GLatLng to the function that identifies the location that most closely matches the address. If no address is found, "null" is passed to the function. (From v2.131a, getLatlng() also accepts a GLatLng as the first parameter, and returns the GLatLng of the nearest geocodable location).
getLocations(address or latlng,function)	Attempts to geocode the address or reverse geocode the latlng. and passes an anonymous structure containing reply details to the function. (Reverse geocoding using getLocations() works in versions from v2.131a)
reset()	Resets the geocoder and clears its cache entries.
setCache(gcache)	Changes the cache being used by the geocoder. If the parameter is omitted, caching is switched off.

Reverse geocoded locations

The reverse geocoder seems to have two modes: street mode and town mode.

If your GLatLng is within about 100 metres of an addressable street known to the database, then the returned information is for the street address. If your GLatLng is more than about 100 metres from a known street address, then the returned information is for a nearby town, which could be tens of kilometres away.

Note that reverse-geocodable addresses are not the same as street locations known to GDirections. Roads that have no properties, such as country lanes and interstates, may have only one reverse-geocodable address along their entire length.

For example, reverse geocoding (28.48282,-82.04569) returns you the correct street name, "N Grade Rd, Webster, FL 33597, USA" but the returned coordinates are over 4 kilometers away. The nearby point (28.48400,-82.04697) is over 100 metres from "N Grade Rd" so it returns "Sumter South, Florida, USA" which is over 21 kilometres away.

GControl()

Constructor new GControl(a,b);

a	bool	Set this true if the control structure is to be included when the map is printed. If false or omitted, the structure is given the attribute class="gmnoprint".
b	bool	Set this true if the control structure is "selectable" (?).

Methods

clear()	undocumented ?????
copy()	undocumented Returns a copy of this GControl
getDefaultPosition()	Set this to a function that returns the default position of your control structure as a GControlPosition() object.
initialize(a)	Set this to a function that creates your control structure. The optional parameter can be anything you want, just pass a suitable value when you use map.addControl() on it.
printable()	Returns the first bool value you set in the constructor
selectable()	Returns the second bool value you set in the constructor

GControlPosition()

Constructor new GControlPosition(anchor,offset);

anchor	integer	Specifies a corner of the map. Use one of the G_ANCHOR_BOTTOM_LEFT type variables.
offset	GSize()	Specifies the distance of the nearest point of the control div from the specified corner.

Methods

apply(element)

Applies style attributes to an element that cause it to be positioned in the specified location. The element need not necessarily be the div of a GControl() object.

example
Suppose we have any HTML element with the attribute id="message". It can be positioned near the top left corner of the map by using

     var pos = new GControlPosition(G_ANCHOR_TOP_LEFT, new GSize(100,10));
     pos.apply(document.getElementById("control"));
     document.getElementById("map").appendChild(document.getElementById("control"));

GCopyright

Constructor GCopyright(id, bounds, minZoom, text)

id	integer	Each GCopyright object must have a different id.
bounds	GLatLngBounds	Specifies the region of the map to which the copyright applies.
minZoom	integer	Specifies the lowest zoom level to which the copyright applies.
text	string	The copyright text to be displayed.
maxZoom	integer	Specifies the highest zoom level to which the copyright applies.
f	boolean	I'm not sure what this does

properties and methods GCopyright has no accessible properties or methods.
 

GCopyrightCollection()

Constructor new GCopyrightCollection(prefix)

parameters

prefix

text

Text to appear in the copyright string before the name of the copyright owner.

methods

addCopyright(gcopyright)	Adds information from a GCopyright object to the collection.
getCopyrightNotice(latlngbounds,zoom)	Returns a string containing the assembled copyright notice for the specified region and zoom level.
getCopyrights(latlngbounds, zoom)	Returns an array of copyright strings that apply to the specified region and zoom level.

GDirections()

Both paramters are optional.

If the first parameter is present, then the route will be plotted on the map as a polyline with start and end markers, and the map will be centred and zoomed to fit the route. (You don't need to have previously performed map.setCenter().)

If the second parameter is present, then the route information will be appended to that HTMLElement, just like they are in the sidebar on maps.google.com.

If both parameters are used, then clicking on the entries in the sidebar will cause blowups to be shown on the map.

Methods

load(query,options)	This is the Method that does all the hard work. The first parameter is a string in the format "from: address to: address ...", e.g. "from: Chicago to: Pittsburgh to: New York" The second parameter contains options Note:GDirections.load() is asynchronous.
loadFromWaypoints(array,options)	The same as .load() except that the first parameter is an array of locations, e.g. ["Chicago", "Pittsburgh"]
clear()	Removes the direction information, removes the overlays, clears out the sidebar info.
getBounds()	returns a GLatLngBounds that bounds the directions
getCopyrightsHtml()	returns a HTML string containing the copyright associated with the directions.
getDistance()	returns an Object that contains the distance information .getDistance().html is a HTML string that describes the distance in suitable units .getDistance().meters is a number indicating the distance in metres
getDuration()	returns an Object that contains the duration information .getDuration().html is a HTML string that describes the duration in suitable units .getDuration().seconds is a number indicating the estimated duration in seconds
getGeocode(n)	returns an Object that contains Geocode information about the start and end points. .getGeocode(n).AddressDetails contains the address details returned from the geocoder .getGeocode(n).Point contains the coordinates as three entries in an array: longitude, latitude and altitude .getGeocode(n).address is a string containing the parsed address .getGeocode(n).id - I don't know what this does.
getMarker(n)	returns a reference to the start or end marker
getNumGeocodes()	returns the number of geocodes
getNumRoutes()	returns the number of routes (each waypoint adds an additional route)
getPolyline()	returns a reference tot he polyline
getRoute(n)	returns a GRoute Object
getStatus()	returns an Object that contains the completion status .getStatus().code returns the status code. 200=success. The error codes are the same as the error codes for geocoding. .getStatus().request always seems to return "directions" even if the error obviously occurred in the geocoding.
getSummaryHtml()	returns a HTML string containing something like "790 mi (about 12 hours 28 mins)"

Options

avoidHighways	bool	Set this true to obtain a route that avoids highways
getPolyline	bool	Instructs the system to return Polyline data. This defaults to true if the GDirections() Object was created with a map parameter.
getSteps	bool	Instructs the system to return text direstions. This defaults to true if the GDirections() Object was created with a sidebar parameter.
locale	string	Specifies the language to be used
preserveViewport	bool	Suppresses the zoom that normally fits the view to the direction results.
travelMode	integer	Set this to G_TRAVEL_MODE_WALKING to obtain a route that is allowed to do things like walk the wrong way up one-way streets, avoids highways, and walks at lower speeds (which affects the choice of fastest route). It even goes at different speeds uphill and downhill.

GDownloadUrl()

You could use this to read a plain text data file, and use the String.split() method to split the result.

You could use this to read snippets of HTML code from a server, and drop the whole thing into a side panel

   loadPanel = function(a) {
     document.getElementById("sidePanel").innerHTML = a;
   }
   GDownloadUrl("server.php?query=getdetials&id=fred", loadPanel);

With the GET method, any request data is limited to the 512 bytes that can be appended as parameters to the end of the URL.
With the POST method, large amounts of request data can be sent to the server, and the MIME type can be specified.

GDraggableObject

Options

container	HTML Element	An element that will act as a bounding box for the draggable object
draggableCursor	string	The cursor to show on mousover.
draggingCurosr	string	The cursor to show while dragging.
left	Number	The left starting position of the object.
top	Number	The top starting position of the object.
restrictX	Boolean	undocumented I have no idea what this does.
scroller	object of unexposed class	undocumented Object that performs the actual drag operation.

Properties

left	Horizontal starting position of object
top	Vertical starting position of object

Note Setting the .top and .left of a GDraggableObject() will not immediately move the html element. The element will jump to the specified position the next time it starts to be dragged.

Static Methods

getDraggableCursor()	Returns a string containing the current draggable cursor setting.
getDraggingCursor()	Returns a string containing the current dragging cursor setting.
setDraggableCursor(string)	Sets the cursor to be used for subsequent draggable objects
setDraggingCursor(string)	Sets the cursor to be used for subsequent draggable objects while they are being dragged

Standard cursors are "auto", "crosshair", "default", "help", "move", "pointer", "text", "wait", and in some browsers "hand".

See Custom Cursors for info about using your own custom cursors.

Instance Methods

disable()	Disables dragging
dragging()	Returns true if the object is currently being dragged
enable()	Enables dragging
enabled()	Returns true if dragging is currently enabled
moveTo(see below)	Moves the object to the specified location
moveBy(see below)	Moves the object by the specified pixel offset

The parameters for .moveTo() in v2.84 to v2.88 were two integers: left, top.
From v2.89 there's a single GPoint() parameter.

The parameters for .moveBy() in v2.86 to v2.88 were two integers: left, top.
From v2.89 there's a single GSize() parameter.

GEvent

Here's a list of the event types that can occur on directly accessible objects.

GCopyrightCollection	newcopyright
GMap2	addmaptype, addoverlay, clearoverlays, click, dblclick, drag, dragend, dragstart, infowindowbeforeclose, infowindowclose, infowindowopen, infowindowprepareopen, infowindowupdate, load, maptypechanged, markerload, markerunload, move, moveend, movestart, mousemove, mouseout, mouseover, mousewheel, removemaptype, removeoverlay, resize, singlerightclick, tilesloaded, zoomend, zooming, zoomstart, DOMMouseScroll
GMap	[all the GMap2 events], zoom
GMapType	newcopyright
GMarker	click, changed, dblclick, infowindowbeforeclose, infowindowclose, infowindowopen, infowindowprepareopen, mousedown, mouseout, mouseover, mouseup, remove, updatejson, visibilitychanged
GMarkerManager	changed
GPolygon	click, remove, visibilitychanged
GPolyline	click, remove, visibilitychanged
GTileLayer	newcopyright
GKeyboardHandler	moveend, movestart
GInfoWindow	animate, closeclick, maximizeclick, maximizeend, restoreclick, restoreend
anything	clearlisteners
document	logclick
GDraggableObject	click, dblclick, drag, dragend, dragstart, mousedown, mouseup, move
GLargeMapControl	zoomto
GGeoXml	load, refreshpointhook
GStreetviewPanorama	drivingdirectionsinfo

GEvent.addDomListener() Adds an event listener to a HTML element.
parameters

a	object	The html element on which the events may occur, e.g. document.getElementById("button")
b	string	The name of the event, e.g. "click" or "moveend"
c	function	A function to handle the event. Can be an anonymous function or a function name.

GEvent.addListener() Adds an event listener.
parameters

a	object	The object on which the events may occur, e.g. a marker or the map
b	string	The name of the event, e.g. "click" or "moveend"
c	function	A function to handle the event. Can be an anonymous function or a function name.

GEvent.bind() Binds the given method of the given object to the given source event
parameters

a	object	The object on which the events may occur, e.g. a marker or the map
b	string	The name of the event, e.g. "click" or "moveend"
c	object	The object which will be the "this" when the method is called
d	method	A method to handle the event

GEvent.bindDom() Binds the given method of the given HTML Element to the given source event
parameters

a	object	The HTML Element on which the events may occur, e.g. document.getElementById("button")
b	string	The name of the event, e.g. "click" or "moveend"
c	object	The object which will be the "this" when the method is called
d	method	A method to handle the event

GEvent.callback() Returns a function that calls the second parameter as a method of the first parameter.
parameters

a	object	the object to which the method is to be applied
b	function	the function to be used as a method of the object

GEvent.callbackArgs() Returns a function that calls the second parameter as a method of the first parameter.
parameters

a	object	the object to which the method is to be applied
b	function	the function to be used as a method of the object

Any additional parameters are passed to the method

GEvent.clearInstanceListeners() Removes all listeners on a specified object.
parameters

a

object

The object on which the events may occur, e.g. a marker or the map

GEvent.clearListeners() Removes all listeners of a specified type on a specified object.
parameters

a	object	The object on which the events may occur, e.g. a marker or the map
b	string	The name of the event, e.g. "click" or "moveend"

GEvent.clearNode() Removes all listeners on a specified object and those on its child nodes.
parameters

a

object

The object on which the events may occur, e.g. a marker or the map

GEvent.removeListener() Removes a named listener.
parameters

a

listener

The listener to be removed. Use the token that was returned from the GEvent.addListener() call

GEvent.trigger() Triggers an event.
parameters

a	object	The object on which the events is to be triggered, e.g. a marker or the map
b	string	The name of the event, e.g. "click" or "moveend"

Any additional parameters are passed tot he event handler function.

GFactualGeocodeCache

Constructor new GFactualGeocodeCache()

It is the same as the GGeocodeCache class, except that its .isCacheable() method performs stricter tests.

GGeocodeCache

Constructor new GGeocodeCache()

Methods

get(address)	Returns the reply that was stored for this address.
isCacheable(reply)	Returns true if the GClientGeocoder.getLocations() reply should be cached.
put(address,reply)	Stores the address and its reply in the cache, if the reply is cacheable.
reset()	Erases the contents of the cache.
toCanonical(address)	Returns the address in "canonical" form, using standardized punctuation and lower case.

GGeoXml

Constructor
GGeoXml accepts an indefinite number of parameters, which include:

parameters

url	string	URL of KML or GeoRSS file The file must be placed on a webhost where the Google server can read it
callback	function	Function to be called when processing is complete
sideBarHandler	function	undocumented Function to be notified of the structure and contents of the items added
opts	options object	undocumented I don't know what options are available.

Use map.addOverlay() to add the overlay to the map.

methods

copy()	Returns a new GOverlay that is a copy of this one.
initialize()	Used by map.addOverlay() to set up the overlay.
redraw()	The overlay is redrawn.
remove()	Used by map.removeOverlay() to recover memory.
supportsHide()	Returns false, thus indicating that the overlay does not support .hide(), .show() and .isHidden()
getDefaultBounds()	Returns a GLatLngBounds that contains all the objects added.
getDefaultCenter()	Returns a GLatLng at the centre of those bounds.
getDefaultSpan()	Returns a GLatLng. The coordinates of the GLatLng represent the width abd height of those bounds.
getTileLayerOverlay()	Returns the tile layer overay that GGoeXml has used, if there is one. Otherwise returns null.
gotoDefaultViewport()	Sets the viewport to fit the objects added
hasLoaded()	Returns true if the loading is complete
loadedCorrectly()	Returns true if the XML file loaded correctly (only meaningful if .hasLoaded() is true)
hide()	Hides all the child overlays that support .hide() .
show()	Unhides all the child overlays that support .hide() .
isHidden()	Returns true if currently hidden by .hide()
supportsHide()	Returns true

Extra overlay properties

GGeoXml can add extra properties to the overlays that it creates. They are all undocumented. Note that not all overlays have all these properties. They always seem to have description, snippet and name but the presence of other properties varies. It's possible that you either get hiddenInStream or (parentGeoXml and parentFolderForCallbackOverlayAddTimeout) I'm not sure about that.

description	text from the <description> field in the KML
name	text from the <name> field in the KML
snippet	text from the <snippet> field in the KML
hiddenInStream	boolean: I don't know what this does
parentFolderForCallbackOverlayAddTimeout	Integer: I don't know what this does
parentGeoXml	pointer to the parent GEoXml object

GGroundOverlay

Constructor new GGroundOverlay(url, latlngbounds, opts)

Use map.addOverlay() to add the overlay to the map.

methods

copy()	Returns a new GOverlay that is a copy of this one.
hide()	Hides the overlay
initialize(map)	Used by map.addOverlay() to set up the overlay.
isHidden()	returns true if the overlay is hidden
redraw()	Redraws the overlay.
remove()	Used by map.removeOverlay() to recover memory.
show()	Shows the overlay
supportsHide()	Returns true, thus indicating that the overlay supports .hide(), .show() and .isHidden()

The .hide() and .show() methods also exist, but they simply throw a "Interface not implemented" error.

I don't know what options exist or what they do. The code that handles the opts is particularly obscure.

GHierarchicalMapTypeControl()

Similar to GMapTypeControl() except that it uses a parent/child layout instead of a row of separate buttons.

It additionally accepts an optional parameters.

parameters

tiny

bool

If present and true, the control will use short names in the map type buttons.

methods

addRelationship(parent, child, name, isDefault)	Makes one map type a child of another. The first two parameters are required references to the parent and child GMapType instances. The third optional parameter allows you to specify a different name for the child box in the layout. The fourth optional parameter can be set true to cause the child maptype to be activated when the parent maptype is selected.
removeRealationship(child)	Removes the relationship from a child GMapType.
clearRelationships()	Clears all the relationships. All GMapTypes become parents.

GIcon()

If the first parameter is present, then all properties of that GIcon() object are copied to the new GIcon().

If the second parameter is present, then it is used for the GIcon().image property.
If the fourth undocumented parameter is present, then it is used for the GIcon().shadow property.
E.g. var myIcon = new GIcon(G_DEFAULT_ICON, "mymarker.png")creates a GIcon() that has the same shape and size as the default icon, but has a different image.

If the third undocumented parameter is present it is used as a "label"
A "label" is an extra image component that lies on top of the main icon image. This feature allows you to build your icon from a background image plus a foreground label. Prior to the introduction of this feature, if you wanted to have markers with different letters and different background colours, you had to create a separate icon image for each combination.
The label is an object of unnamed class that has the following properties:
label undocumented

url	This string identifies the URL of the label image file.
size	A GSize() object that identifies the pixel size of the label image.
anchor	A GPoint() object that identifies the position offset of the label image relative to the main image.

properties

image	This string identifies the main image of the marker.
iconSize	A GSize() object that identifies the pixel size of the main image.
shadow	Optional string that identifies the image to be used for the shadow.
shadowSize	A GSize() object that identifies the pixel size of the shadow image.
iconAnchor	A GPoint() object which identifies the pixel which will be placed on the specified geographical location. You can think of it as the point that the image points at.
infoWindowAnchor	A GPoint() object which identifies the pixel that the tip of the info window stem will touch.
label	undocumented (Optional) see above
transparent	(Optional) is the name of a transparent image used for capturing clicks and mouseovers in IE.
printImage	(Optional) identifies a GIF file to be used for printing.
mozPrintImage	(Optional) identifies a GIF file to be used for printing from the Mozilla or Firefox browser.
printShadow	(Optional) identifies a GIF file to be used for printing the shadow.
imageMap	(Optional) an array of integers representing the "shape" parameters of a HTML ImageMap. Used for capturing marker clicks in non-IE browsers.
imageMapType	(Optional) Undocumented specifies the shape type of the ImageMap. Can be "poly", "circle" or "rect".
dragCrossAnchor	GPoint(): indicates the hot spot of the drag cross image, but with the x coordinate negated. E.g. if you want the anchor point of your image to be the pixel (4,9) then you need to specify "new GPoint(-4,9)"
dragCrossImage	String: indicates an image to be used as the drag cross. If you set it to the null string, you get the default drag_cross_67_16.png image.
dragCrossSize	GSize(): indicates the size of the drag cross.
maxHeight	integer: The maximum difference in height between the marker anchor and the drag cross anchor during dragging. Setting the maxHeight to zero causes it to use the default 13.
sprite	Undocumented Object of format {image:string, width:number, height:number}. If it exists, it is used instead of .image and .iconSize

GInfoWindow()

The class itself in no longer exposed, so you can't create new GInfoWindow() objects.

Properties GInfoWindow has no accessible properties

methods

create(pane1,pane2)	undocumented Used by .initialize() to create the divs. The parameters are references to the panes in which the info window and the shadow are to be placed.
getContentContainers()	Returns the array of HTML Elements reprenting the contents of each tab.
getTabs()	Returns the array of GInfoWindowTab() objects in this info window
maximize(instant)	Expands the infowindow. Only works if the infowindow has a maxUrl or maxContent. If the undocumented parameter is true, then the large infowindow opens instantly, otherwise an animation is performed.
restore(instant)	Contracts an expanded infowindow. Only works if the infowindow has a maxUrl or maxContent. If the undocumented parameter is true, then the small infowindow opens instantly, otherwise an animation is performed.
getPixelOffset()	Returns the pixel offset of the info window
getPoint()	Returns a GLatLng indicating the location of the info window
getSelectedTab()	Returns a number indicating which tab is selected, counting from zero.
hide()	Makes the info window invisible
initialize(map)	undocumented Used by the openInfoWIndow methods to create the info window if it does not exist
isHidden()	Returns true if the info window is hidden or closed
redraw(force)	undocumented Redaws the info window if the parameter is true.
remove()	undocumented destroys the info window divs
reset(point, tabs, size, offset, selectedTab)	Changes some or all of the info window properties. The fourth and fifth arguments are optional. point: a GLatLng() indicating the geographical location. tabs: array of GInfoWindowTab()s with HTML DOM elements (not HTML text strings) in the contentElem. size: a GSize() indicating the size of the info window display area. When using .reset(), the API will not automatically calculate the size for you, but will enforce the minimum size if you try to set it smaller. offset: (optional) a GSize() indicating the pixel offset. selectedTab: (optional) an integer indicating which tab is selected.
selectTab(i)	Activates the specified tab
show()	Makes the info window visible
supportsHide()	Returns true, thus indicating that the overlay supports .hide(), .show() and .isHidden()
disableMaximize()	If the info window is open, removes the "maximize" icon from the info window and disables maximization.
enableMaximize()	If the info window is open, displays the "maximize" icon in the info window and enables maximization if the corresponding options are set.
copy()	Undocumented Currently does nothing.

GInfoWindowTab()

Constructor
new GInfoWindowTab(label,contents)

properties

contentElem	undocumented HTML elements representing the contents of the info window corresponding to this tab It must be a HTML DOM element if using .openInfoWindow(), and must be a HTML string if using .openInfoWindowHtml().
name	undocumented Text displayed in the tab to identify it
onclick	undocumented Possibly an optional function to be called when the tab is clicked.

GKeyboardHandler()

Constructor
new GKeyboardHandler(map,window)

(The second parameter is undocumented)

The GKeyboardHandler has no accessible properties or methods.

GLargeMapControl()

GLargeMapControl3D()

GLatLng()

Constructor new GLatLng(latitude,longitude, nofix)
(Note that the latitude and longitude are in the opposite order from GPoint)
If the optional nofix parameter is absent or false, the latitude is restricted to the range -90 to +90, and the longitude is wrapped round the globe to the value in the range -180 to +180. E.g. (-100,270) would become (-90,-90)

The constructor initially creates the x and y parameters as copies of the hidden parameters that control the location. Changing the values of the x and y parameters does not change the location of the GLatLng object.

Properties

y	Latitude expressed in degrees (read only, deprecated)
x	Longitude expressed in degrees (read only, deprecated)

Methods

lat()	Returns the latitude
lng()	Returns the longitude
latRadians()	Returns the latitude expressed in radians
lngRadians()	Returns the longitude expressed in radians
distanceFrom(latlng, radius of planet)	Returns the distance expressed in metres from the specified location. The second parameter is optional.
equals(latlng)	Returns true if the two latlngs identify the same location
toString()	undocumented Returns a string in the format "(1.123456789,-1.123456789)"
toUrlValue(n)	Returns a string in the format "1.123457,-1.123457". The values are rounded to n decimal places (default 6).

Static Methods

GLatLng.fromRadians(lat,lng,nofix)	undocumented Constructs a GLatLng from radian values instead of degrees
GLatLng.fromUrlValue(string)	undocumented Constructs a GLatLng from a string in the format "1.123457,-1.123457".

GLatLngBounds()

Constructor new GLatLngBounds(latlng,latlng)
If two parameters are passed, they are taken to represent the SouthWest and NorthEast corners of the rectangle. The corners must be in the right order for it to work correctly.
If one parameter is passed, the region contains just that point.
If no parameters are passed, the regions is set to the empty region GLatLngBounds(new GLatLng(57.29577951308232, 180), GLatLng(-57.29577951308232, -180)). (The corners are in the wrong order).

All the coordinates are normalized into the range -90 to +90 for the latitudes and -180 to +180 for the longitudes.
properties: GLatLngBounds has no accessible properties

Methods

contains(latlng)	Returns true if the bounds contain the location
containsBounds(latlngbounds)	Returns true if it fully contains the other bounds
containsLatLng(glatlng)	Returns true if it contains the GLatLng
equals(latlngbounds)	Returns true if the bounds are equal
extend(latlng)	Enlarges the bounds to be the smallest rectangle containing the previous area plus the specified location
getCenter()	Returns a GLatLng representing the centre
getNorthEast()	Returns a GLatLng representing the NorthEast corner
getSouthWest()	Returns a GLatLng representing the SouthWest corner
intersects(latlngbounds)	Returns true if the two bounds intersect
isEmpty()	Returns true if the bounds specify a negative region (i.e. the corners are specified in the wrong order)
isFullLat()	Returns true if the latitude range covers the whole Earth from -90 to +90
isFullLng()	Returns true if the longitude range covers the whole Earth -180 to +180
toSpan()	Returns a GLatLng object which represents the width and height of the region.
toString()	undocumented Returns a string in the format ((33.123, -120.123), (45.123, -100.233)). The values may differ slightly from what you originally specified due to being converted to radians and back to degrees.

Static Methods

GLatLng.fromUrlValue(string)

undocumented Constructs a GLatLngBounds from a string which contains four numbers separated by commas. Other punctuation is ignored, so a string with brackets, like that output by .toString(), will also work.

GLayer()

Constructor new GLayer(ID or LMC)

The list of official IDs is at spreadsheets.google.com/pub?key=p9pdwsai2hDN-cAocTLhnag . In additon to the official IDs, there are "com.paroramio.popular" and a few more Wikipedia languages than are officially listed.

It's also possible to use an LMC instead of an ID. The only available LMC that I lnow of that doesn't have an ID is "lmc:panoramio/1". Use map.addOverlay() to add the overlay to the map.

methods

initialize(map)	Used by map.addOverlay() to set up the overlay.
hide()	Hides the layer
redraw(bool)	Redraws the overlay.
remove()	Used by map.removeOverlay() to recover memory.
show()	Shows a hidden layer
setParameter()	undocumented I don't know what this does

static methods

addInitializer()	undocumented I don't know what this does
isHidden(ID)	Returns true if the specified layer is hidden

GLoad()

This function is used during the API loading sequence, to load the API.
 

GLoadMapsScript()

This function is used during the API loading sequence to load the selected API Javascript file.
 

GLog()

methods

write(txt,colour)	Writes the text to a log window that appears at the bottom of the screen. The optional colour parameter can be a string containing a colour specification, like "blue" or "#FF8888".
writeHtml(txt)	Writes the text to a log window that appears at the bottom of the screen, applying any HTML formatting.
writeUrl(txt)	Writes the text to a log window that appears at the bottom of the screen, formatted as a clickable link.
getMessages()	undocumented Returns an array of strings containing the text of all messages perviously written.

GMap()

Constructor new GMap(a,b,c,d)

parameters

a	html element	The map container, usually a <div>
b[ ]	array of maptypes	(optional) list of map types allowed on this map
c	integer	(optional) Width of map
d	integer	(optional) Height of map

properties GMap() has no accessible properties

additional methods

centerAndZoom(point,zoom)	Centres and zooms the map
centerAtLatLng(point)	Centres the map
getBoundsLatLng()	Returns a GBounds() object identifying the map bounds.
getCenterLatLng()	Returns a GPoint() identifying the centre
getSpanLatLng()	Returns a GSize() identifying the width and height of the map in lng and lat degrees
getZoomLevel()	Returns the APIv1 type zoom level. Note that this can be a negative value when the new deep v2 zoom levels are active.
openInfoWindowXslt()	Does nothing
recenterOrPanToLatLng(point)	Centres the map, doing a fluid pan to the point if it is within the current viewport
zoomTo(zoom)

overwritten methods These methods overwrite the GMap2() methods of the same name

setMapType(a)	Sets the map type. The parameter is a GMapType() object.
openInfoWindow(a,b,c,d,e)	Opens the info window, see below for parameters
openInfoWindowHtml(a,b,c,d,e)	Opens the info window, see below for parameters

Modified Event	Returns
zoomend	oldZoom, newZoom (using APIv1 zoom level syntax)

GMap2()

parameters

container	html element	The map container, usually a <div>
opts	(optional)Anonymous object	may contain more information

opts If you want to set up any of the other internal properties of your GMap2() you have to bundle them into an anonymous object. The constructor copies the named properties of this anonymous object into the hidden internal properties of the GMap2. E.g.

  var map = new GMap2(document.getElementById("map"),{mapTypes:[G_SATELLITE_TYPE]});

Standard cursors are "auto", "crosshair", "default", "help", "move", "pointer", "text", "wait", and in some browsers "hand".

See Custom Cursors for info about using your own custom cursors.

googleBarOptions

The possible entries in the googleBarOptions are:

option	type	purpose
linkTarget	string	Use one of these string variables to control the link target pane G_GOOGLEBAR_LINK_TARGET_BLANK, G_GOOGLEBAR_LINK_TARGET_PARENT, G_GOOGLEBAR_LINK_TARGET_SELF, G_GOOGLEBAR_LINK_TARGET_TOP
resultList	string	Use one of these string variables to control result list suppression G_GOOGLEBAR_RESULT_LIST_INLINE, G_GOOGLEBAR_RESULT_LIST_SUPPRESS
onGenerateMarkerHtmlCallback	function	Function to be called when the info window is about to be opened on one of the results. Must return the (modified) html string to be used for the info window contents.
onIdleCallback	function	Function be be called when the GoogleBar finishes searching
onMarkersSetCallback	function	Function to be called after the markers have been placed on the map.
onSearchCompleteCallback	function	Function to be called when the search is complete, before the reults are plotted
showOnLoad	bool	If true, the Google Bar will be expanded when the map has loaded.
suppressInitialResultSelection	bool	If true, the info window is not opened on the firest result.
suppressZoomToBounds	bool	If true, the map does not zoom and pan to fit the results.

methods

addControl(control,controlposition)	Causes the GControl() object to be added to the map If a GControlPosition() is not specified, the getDefaultPosition() is used.
addMapType(maptype)	Adds a map type to the map
addOverlay(overlay)	Causes the overlay to be added to the map.
checkResize()	Checks to see if the map container has changed size, and if so resizes the map
clearOverlays()	Removes all overlays except GTileLayerOverlay()s.
closeInfoWindow()	Closes the info window
continuousZoomEnabled()	Returns true if "continuous zoom" animations are enabled.
disableContinuousZoom()	Disables the "continuous zoom" animations.
disableDoubleClickZoom()	Causes double-click to just centre the map.
disableDragging()	Disables map dragging
disableGoogleBar()	Removes the Google Bar
disableInfoWindow()	Disables the info window
diablePinchToZoom()	Disables the Pinch-to-zoom feature on multitouch capable devices.
disableScrollWheelZoom()	Disables the scroll wheel zoom.
doubleClickZoomEnabled()	Returns true if double click zoom is enabled.
draggingEnabled()	Returns true if map dragging is enabled.
enableContinuousZoom()	Enables the "continuous zoom" animations - zooming in or out by one level is then amimated.
enableDragging()	Enables map dragging.
enableDoubleClickZoom()	Causes double-click to zoom in by one level and centre the map.
enableInfoWindow()	Enables the info window
enableGoogleBar()	Activates a Google Bar on top of the Google Logo
enablePinchToZoom()	Enables the Pinch-to-zoom feature on multitouch capable devices.
enableScrollWheelZoom()	Enables the scroll wheel zoom.
focus()	Undocumented If the info window is open, returns its location as a GLatLng().
fromContainerPixelToLatLng(point)	Converts a container pixel to a GLatLng()
fromDivPixelToLatLng(latlng,nofix)	Converts a "dragObject" div pixel to a GLatLng() If the optional second undocumented parameter is true, then the output is not normalized. Note: The values for ContainerPixel and DivPixel are initially the same, but the div moves when the map pans and the container doesn't. Markers keep the same DivPixel position when the map moves, and only get a new value when it zooms.
fromLatLngToContainerPixel(latlng)	Converts a GLatLng() to a pixel relative to the map container.
fromLatLngToDivPixel(latlng,point)	Converts a GLatLng() to a "dragObject" div pixel The optional second parameter is for resolving normalization ambiguities. When zoomed out, the same latlng position can be present on more than one tile. Without the second parameter, the copy nearest the centre is chosen. If the second parameter is present, its .x value controls which copy is chosen.
getBounds()	Returns a GLatLngBounds which indicates the bounds of the region covered by the map.
getBoundsZoomLevel(latlngbounds)	Returns the number of the deepest permitted zoom level of the current map type which is large enough to contain the specified region.
getCenter()	Returns a GLatLng() indicating the centre point of the map.
getContainer()	Returns a reference to the map <div>
getCurrentMapType()	Returns a reference to the current GMapType()
getDefaultUI()	Returns the default User Interface for this map.
.getDragObject()	Returns a reference to the special GDraggableObject that contains all the parts of the map that move when the map pans: the map tiles and overlays, but not the map controls. All the properties and instance methods of GDraggableObject are accessible.
.getEarthInstance(callbackfn)	Obtains the instance of the Google Eath Plugin. The instance reference is returned to the callback function. Posessing the instance reference allows Google Earth API calls to be performed on the Google Earth maptype within Google Maps. For example this call makes the Google Map "borders" layer visible. map.getEarthInstance(function(earth) { earth.getLayerRoot().enableLayerById(earth.LAYER_BORDERS, true); });
getInfoWindow()	Returns a reference to the info window object.
getMapTypes()	Returns an array of GMapType()s that are allowed on this map.
getPane(i)	Returns a reference to one of the map panes. The draggable part of the map contains seven html <div> elements referred to as "panes". Different types of map elements are placed in different panes, e.g. the map tiles are placed in the lowest pane, markers are placed on a higher plane. The values G_MAP_MARKER_SHADOW_PANE, G_MAP_MARKER_PANE, G_MAP_FLOAT_SHADOW_PANE, G_MAP_MARKER_MOUSE_TARGET_PANE, G_MAP_FLOAT_PANE can be used to specify a specific pane.
getSize()	Returns a GSize() object indicating the size of the map in pixels.
getZoom()	Returns the current zoom level number.
hideControls()	undocumented Hides all hideable controls. The Logo, copyright and Terms are not hideable, all other controls are hideable.
infoWindowEnabled()	Returns true if the info window is enabled
infoWindowSizeWatcher()	undocumented This has something to do with GGeoXml.
isLoaded()	Returns true if the map has a map type. When initially created, a map has no map type. It will be given a map type the first time that setCenter() or setMapType() or setZoom() is used.
openInfoWindow(a,b,c)	Opens the info window, see below for parameters
openInfoWindowHtml(a,b,c)	Opens the info window, see below for parameters
openInfoWindowTabs(a,b,c)	Opens the info window, see below for parameters
openInfoWindowTabsHtml(a,b,c)	Opens the info window, see below for parameters
panBy(gsize)	Pans the map by the specified number of pixels in the x and y directions.
panDirection(a,b)	Pans in the direction specified by (a,b) e.g. map.panDirection(2,-1) causes the screen to pan two units North and one unit West Each pan unit is equal to half a screen.
panTo(a)	Recentres or pans to the specified GLatLng() position
pinchToZoomEnabled()	Returns true if the Pinch-to-zoom feature for multitouch capable devices is enabled.
removeControl(a)	Removes a GControl(). The parameter is the token returned from addControl()
removeMapType(maptype)	Removes a map type
removeOverlay(a)	Removes an overlay.
returnToSavedPosition()	Resets the map to the values saved by map.savePosition()
savePosition()	Saves the map centre and zoom level information which gets used when the user clicks on the "Return to last result" icon
scrollWheelZoomEnabled()	Returns true if the scroll wheel zoom is enabled.
setCenter(a,b,c)	If "a" is present, it is a GLatLng() specifying the new map centre. If "b" is present, it is n integer specifying the new zoom level. If "c" is present, it is a GMapType() specifying the new map type. All three parameters are optional.
setUI(gmapuioptions)	Activates the specified User Interface.
setUIToDefault()	Activates the default User Interface for this map.
setFocus(latlng,force)	undocumented Normally when you zoom in or out, the centre point stays in a fixed location on the screen. setFocus(latlng) changes this behaviour so that the specified point is the one that remains in a fixed location. If a zoom animation is in progress, then setFocus is ignored unless the second parameter is set true. setFocus() with no parameters changes things back to the default behaviour.
setMapType(a)	Sets the map type. The parameter is a GMapType() object.
setZoom(a)	Sets the zoom level. The parameter is an integer.
showControls()	undocumented Makes hidden controls visible.
showMapBlowup(a,b)	Opens the info window with a blowup maplet, see below for parameters
zoomIn(latlng,bool,bool)	Zooms in by one zoom level If the first undocumented parameter is present and the second parameter is present and true, then the map is centred at the specified GLatLng If the first undocumented parameter is present and the second parameter is absent or false, then the map centre is shifted in such a way that the specified GLatLng remains in the same position relative to the map container If the third undocumented parameter is present and set to true, then an animated zoom is performed if continuous zoom is enabled.
zoomOut(latlng,bool)	Zooms out by one zoom level If the first undocumented parameter is present then the map centre is shifted in such a way that the specified GLatLng remains in the same position relative to the map container If the second undocumented parameter is present and set to true, then an animated zoom is performed if continuous zoom is enabled.
updateCurrentTab(modifier function, onupdate function)	Updates the currently selected info window tab, causing a resize of the info window, without repositioning. The modifier function is used to modify the currently selected tab and is passed a GInfoWindowTab as an argument.
updateInfoWindow(tabs, onupdate function)	Updates the content of the currently open info window, without repositioning. The info window is resized to fit the new content.

Event	Returns
addmaptype	maptype
addoverlay	overlay
clearoverlays	none
click	overlay, latlng
dblclick	overlay, latlng (the first parameter is always null)
drag	none
dragend	none
dragstart	none
infowindowbeforeclose	none
infowindowclose	none
infowindowopen	none
load	none
maptypechanged	none
move	none
moveend	none
movestart	none
mousemove	latlng
mouseout	latlng
mouseover	latlng
removemaptype	maptype
removeoverlay	overlay
resizeundocumented	none
singlerightclick	latlng, src, overlay
zoomend	oldZoom, newZoom
zoomingundocumented	none
zoomstartundocumented	direction (+1=in, -1=out), latlng pivot, bool recentering

openInfoWindow() Methods

I'm documenting them all in one chunk here, rather than repeating all the details 15 times.

The different methods take slightly different parameters. Chosen from this list:

point	GLatLng()	Geographical location.
htmlElem	HTML DOM element	Info Window contents expressed as a DOM Element.
htmlStr	HTML string	Info Window contents expressed as a string.
tabElemArray	array of GInfoWindowTab()s	One for each tab, with a HTML DOM element in the contentElem
tabStrArray	array of GInfoWindowTab()s	One for each tab, with a HTML string in the contentElem
offset	GSize()	(Optional) Pixel offset from the point.
selectedTab	integer	(Optional) Specifies the number of the tab to be initially selected. Counting from zero. If omitted, tab zero is selected.
maxWidth	integer	(Optional) (Possibly) Maximum width that can be considered for info window contents size calculations. If omitted, the screen.width is used. The height calculations go wrong if this is set less than 217, the minimum infoWindow contents width.
openFn	function	(Optional) Function to be called when the info window opens.
closeFn	function	(Optional) Function to be called when the info window closes.
opts	anonymous object	(Optional) may contain some or all of the following object properties: selectedTab: integer maxWidth: integer noCloseOnClick: boolean onOpenFn: function onCloseFn: function zoomLevel: integer mapType: GMapType() maxContent: string maxTitle: string pixelOffset: GSize() undocumented maxHeight: integer undocumented autoScroll: boolean undocumented onPrepareOpenFn: function undocumented onBeforeCloseFn: function undocumented suppressMapPan: boolean undocumented limitSizeToMap: boolean undocumented contentSize: GSize undocumented noClearOnClose: boolean undocumented noCloseBeforeOpen: boolean undocumented onCloseClick:function undocumented onMaximizeClick:function undocumented onRestoreClick:function undocumented buttons: See below for example: {pixelOffset:new GSize(32,5), maxWidth: 540} Note: The onOpenFn, onPrepareOpenFn, onCloseFn and onBeforeCloseFn options only work for the map methods. When using marker.infoWindowOpen*(), those options are hijacked and replaced by calls to API internal functions that throw the corresponding events on the marker.
zoom	integer	(Optional) Zoom level for the contained map.
maptype	GMapType()	(Optional) Map type for the contained map

The individual methods take the following parameters:

GMap2().openInfoWindow(point,htmlElem, opts)
GMap2().openInfoWindowHtml(point, htmlStr, opts)
GMap2().openInfoWindowTabs(point, tabElemArray, opts)
GMap2().openInfoWindowTabsHtml(point, tabStrArray, opts)

GMap().openInfoWindow(point, htmlElem, offset, openFn, closeFn)
GMap().openInfoWindowHtml(point, htmlStr, offset, openFn, closeFn)
GMap().openInfoWindowTabs(point, tabElemArray, opts)
GMap().openInfoWindowTabsHtml(point, tabStrArray, opts)

marker.openInfoWindow(htmlElem, opts)
marker.openInfoWindowHtml(htmlStr, opts)
marker.openInfoWindowTabs(tabElemArray, opts)
marker.openInfoWindowTabsHtml(tabStrArray, opts)

GMap2().showMapBlowup(point, opts)
GMap().showMapBlowup(point, zoom, maptype, offset, openFn, closeFn)
marker.showMapBlowup(opts)

In addition there is GMap().openInfoWindowXslt() and marker.openInfoWindowXslt(). These methods do nothing. They do not open an info window. They exist only so that maps written using this documented v1 syntax don't crash.

openInfoWindow() {buttons} option

It's a bit complicated, because there are three layers of options:

• The {buttons} option itself
• The options for specifying the four types of button: close, maximise, restore and fullscreen
• The options for specifying the details of each button.

     marker.openInfoWindowHtml(html, {buttons:{close:{height:16,width:5}}});

The syntax allows for lots of different button details to be set, but many of them get countermanded by the API. The only ones that you can actually change are

• width:
• height:
• padding:
• show:

The show: option is bit coded, except that show:0 has a special meaning

• show:0 show in all situations
• show:1 not used in the API
• show:2 show when the info window is normal
• show:4 not used in the API
• show:8 show when the info window is maximised
• show:16 not used in the API (info window is full screen)

If you cause a button to be displayed in an inappropriate context, e.g. the restore button in a non-maximized info window, then the button will do nothing. So the options are really only useful for adjusting the positions of the buttons and for switching them off (e.g. switching off the restore button so that the user can't switch back to the non-maximized info window).

The details of this option have changed from time to time. If you do use it, I recommend locking in to a specific release of the API code, so that if the syntax changes in later releases it won't affect your page.

GMapType()

Constructor new GMapType(tileLayers, projection, name, opts)
parameters

tilelayers	An array of GTileLayer() objects
projection	A reference to the projection function, e.g. new GMercatorProjection(22)
name	The long name for the map type
opts	(optional)An anonymous object which may contain more information

opts If you want to set up any of the other internal properties of your GMapType() you have to bundle them into an anonymous object. The constructor copies the named properties of this anonymous object into the hidden internal properties of the GMapType.
 

option	purpose	default
shortName	Name to be used if GMapTypeControl() is in "tiny" mode	""
urlArg	A string which can be used to identify the map type. It can be used to link copyright information to map types.	"c"
maxResolution	Maximum zoom level supported	The highest zoom level supported by any of the GTileLayers
minResolution	Minimum zoom level supported	The lowest zoom level supported by any of the GTileLayers
textColor	the text colour to by used for any text drawn above the map (e.g. the copyright text, and the numbers in GScaleControl). Can use a named colour, like "black", or a hex value like "#ffffff".	"black"
linkColor	the text colour to be used for any links that are drawn above the map (e.g. "Terms of Use"). It can use a named colour, like "black", or a hex value like "#ffffff".	"#7777cc"
tileSize	an integer that specifies the size of the tiles. Tiles are always square.	256
errorMessge	a string containing the error message to be used if no tile can be served.	""
alt	a string containing the tooltip text to be used in the GMapTypeControl.	""
radius	Radius of planet (not currently used) defaults to 6378137	""
enableZoomLevelLimits	????	""

properties

PIXEL_MARGIN

Margin to be added when using getSpanZoomLevel. Defaults to 3 pixels.

methods

getBoundsZoomLevel(latlngbounds,viewsize)	Returns the highest supported zoom level for which the latlngbounds will fit in the specified viewsize.
getErrorMessage()	Returns a string containing the error message to be used if no tile can be served.
getLinkColor()	Returns the text colour to be used for any links that are drawn above the map (e.g. "Terms of Use"). It can use a named colour, like "black", or a hex value like "#ffffff".
getMaximumResolution(a)	Returns the number of the highest Zoom level that the map type supports. The function is coded to accept an optional parameter, but that parameter is always void.
getMinimumResolution()	Returns the number of the lowest Zoom level that the map type supports.
getName(bool)	Returns the name to be used in GMapTypeControl(). If the optional parameter is present and true, returns the short name to be used on tiny maps.
getProjection()	Returns the GProjection() object associated with the map type.
getSpanZoomLevel(latlng,latlng,viewsize)	Returns the highest supported zoom level for which a map centred at the first latlng will have a span greater than or equal to that specified by the second latlng plus the PIXEL_MARGIN. If no supported zoom level achieves that, it will return zero, even if that's not supported by this map type.
getTextColor()	Returns the text colour to by used for any text drawn above the map (e.g. the copyright text, and the numbers in GScaleControl). Can use a named colour, like "black", or a hex value like "#ffffff".
getTileLayers()	Returns an array of GTileLayer() objects. A map type can have more than one layer (as does G_HYBRID_MAP)
getTileSize()	Returns an integer that specifies the size of the tiles. Tiles are always square.
getUrlArg()	Returns a (one-character) string which can be used to identify the map type. It is used to identify the map type in the &t= parameter of Google Local.
getAlt()	Returns the alternate text associated with the map type button for this map type

GMapTypeControl()

It additionally accepts an optional parameter.
parameters

a

bool

If present and true, the control will use short names in the map type buttons.

GMapUIOptions()

Constructor
new GMapUIOptions(gsize)

If the parameter is omitted, the returned GMapUIOptions has no properties (the "controls", "maptypes" and "zoom" properties must then be added before it can be used in a map.setUI() call).

If the gsize parameter is present, then the default UIOptions for a map of the specified size is returned.

properties

controls	specifies the map controls to be displayed. The options are: {largemapcontrol3d}, {smallzoomcontrol3D}, {maptypecontrol}, {menumaptypecontrol}, {scalecontrol} each of which are boolean
keyboard	(optional) boolean
maptypes	specifies the maptypes to be used.The options are: {hybrid}, {normal}, {physical}, {satellite} each of which are boolean
zoom	specifies whether double clicks or scroll wheel movements zoom the map.The options are: {doubleclick}, {scrollwheel} each of which are boolean

E.g.

      var ui = new GMapUIOptions();
          ui.maptypes = {normal:true, physical:true}
          ui.zoom = {};
          ui.controls = {largemapcontrol3d:true};
          ui.keyboard = false;
      map.setUI(ui); 

GMarker()

Constructor format 1 new GMarker(point, icon, inert) deprecated

point	GLatLng()	Specifies the geographical location where the marker is to be plotted.
icon	GIcon()	(Optional) Icon to be plotted. If omitted, G_DEFAULT_ICON is used.
inert	bool	(Optional) If true, the .clickable property is set false.

Constructor format 2 new GMarker(point, opts)

point	GLatLng()	Specifies the geographical location where the marker is to be plotted.
opts	(optional)Anonymous object	may contain more information

opts You can use either format for the GMarker constructor. The "draggable" option can only be set using format 2.

E.g. var marker = new GMarker(point, {icon: myIcon, draggable:true});
 

option	type	purpose
autoPan	boolean	Set false to disable map autopanning when this marker is dragged to the edge of the map.
bouncy	boolean	Set false to disable the silly bounce animation of draggable markers.
bounceGravity	float	Controls the downward acceleration of a released draggable marker
bounceTimeout	integer	undocumented Controls the time between animation frames of a released draggable marker (and hence the velocity)
clickable	bool	false to make the marker inert
description	string	undocumented I don't know what this does.
draggable	bool	true to make the marker draggable
dragCrossMove	bool	true to make the cross move downwards rather than the icon move upwards during dragging.
hide	bool	true to make marker initially hidden
icon	GIcon()	Icon to be plotted. If omitted, G_DEFAULT_ICON is used.
id	string	undocumented sets the marker.id property
name	string	undocumented I don't know what this does.
title	string	tooltip text
zIndexProcess	function(GMarker) returning an integer	Instead of having the API determine the way that one marker overlays another, you can associate a zIndexProcess with a marker which returns the value that that API will use for the z-index. See Setting the z-index of markers

A GMarker() has no accessible properties

methods

copy()	undocumented Returns a new GMarker that is a copy of this one.
disableDragging()	Disables marker dragging.
dragabble()	Returns true if this marker was created as a draggable marker
dragging()	undocumented returns true if this marker is currently being dragged
draggingEnabled()	Returns true if dragging is enabled on this marker
enable Dragging()	Enables dragging, if the marker was created as a draggable marker
getIcon()	Returns the GIcon() associated with the marker
getPoint()	Returns the GLatLng() where the marker is located
getLatLng()	Returns the GLatLng() where the marker is located [an alias of getPoint().]
hide()	Hides the marker
initialize(map)	Used by map.addOverlay() to set up the marker.
isHidden()	Returns true if the marker is hidden
openInfoWindow(a,b)	Opens the info window, see above for parameters
openInfoWindowHtml(a,b)	Opens the info window, see above for parameters
openInfoWindowTabs(a,b)	Opens the info window, see above for parameters
openInfoWindowTabsHtml(a,b)	Opens the info window, see above for parameters
redraw(bool)	If the optional parameter is present and true, the marker is redrawn.
remove()	Destroys the images[ ]. Used by map.removeOverlay() to recover memory.
setImage(filename)	Changes the marker image.
setPoint(latlng)	Changes the location of the marker, recalculates the z-index and redraws it.
setLatLng(latlng)	Changes the location of the marker, recalculates the z-index and redraws it. [an alias of setPoint().]
show()	Makes a hidden marker visible
showMapBlowup(a,b)	Opens the info window with a blowup maplet, see above for parameters
getTitle()	Returns the {title} associated with this marker.
closeInfoWindow()	Closes the info window only if the info window is associated with this marker.
bindInfoWindow(node,options)	See below.
bindInfoWindowHtml(text,options)	See below.
bindInfoWindowTabs(tabElemArray,options)	See below.
bindInfoWindowTabsHtml(tabStrArray,options)	See below.

The marker.bindInfoWindow*() methods create GEvent listeners that perform the corresponding marker.openInfoWindow*() calls when the marker is clicked.

E.g.
  marker.bindInfoWindowHtml("hello world",{maxWidth:500})
seems to be shorthand for

GEvent.addListener(marker,"click", function() {
  marker.openInfoWindowHtml("hello world",{maxWidth:500});
});

There are differences in the timing of the evaluation of the variables. You don't need a createMarker() function to hold function closure on the .bindInfoWindow() parameters.

GMarkerManager()

Constructor new GMarkerManager(map, options)

properties
There are no accessible properties

Options

borderPadding	integer	Specifies, in pixels, the extra padding outside the map's current viewport monitored by a manager. Increasing the value makes it more likely that a marker will be already rendered when the map pans, but decreases the efficiency of redrawing the markers (e.g. when the zoom level changes).
maxZoom	integer	The maximum zoom level to be managed. Defaults to the max zoom of the map type that is current when the manager is created.
trackMarkers	boolean	Automatically refresh the marker display when a managed marker changes position with .setPoint().

methods

addMarker(marker, minzoom, maxzoom)	Adds a marker to be displayed when the zoom number is in the specified range.
addMarkers(markerArray, minzoom, maxzoom)	Adds an array of markers to be displayed when the zoom number is in the specified range.
getMarkerCount(zoom)	Returns the number of managed markers for the specified zoom level.
refresh()	Redraws the managed markers.

GMenuMapTypeControl()

Similar to GMapTypeControl() except that it uses a drop down menu instead of separate buttons.

It additionally accepts two optional parameters.
parameters

a	bool	If present and true, the control will use short names in the map type buttons.
b	bool	undocumented If present and true, the control will have an extra border.

GMercatorProjection()

The GMercatorProjection() constructor and methods assume a tile size of 256 by 256. The getTileSize() information from the GMapType() is not used.

Constructor
new GMercatorProjection(maxResolution)

properties
There are no accessible properties

methods

fromLatLngToPixel(latlng,zoom)	Returns a GPoint() containing the pixel position (in the tilespace) corresponding to the geographical location.
fromPixelToLatLng(point,zoom,nofix)	Returns a GLatLng() containing the geographical location corresponding to the point in tilespace. If the optional nofix parameter is not present, out of range latitudes are fixed to +-90, and out of range longitudes are wrapped around the globe into the range +-180.
getWrapWidth(zoom)	Returns the wrap width of the tile space in pixels.
tileCheckRange(point,zoom,tilesize)	Returns true if point.y is within the tilespace for the specified zoom level, and wraps point.x around the globe to a value that is within the tilespace. If point.y is outside the tilespace, then it returns false without wrapping point.x.

The tilespace is a square array of tiles that cover the Earth.
The Mercator projection never actually reaches the poles. In this implementation, the mapping stops at about latitude 85.0511.
The pixel represented by GPoint(0,0) always represents the geographical location GLatLng(85.0511, -180).
At zoom level 0, there is one tile, tileBounds[0] is 1, pixelOrigo[0] is GPoint(128,128) - the distance from a corner of that tile to the centre.
At zoom level 1, there are four tiles in a 2*2 grid, tileBounds[1] is 2, pixelOrigo[1] is GPoint(256,256).
At zoom level 17, there are 17,179,869,184 tiles in a 131072*131072 grid, tileBounds[17] is 131072, pixelOrigo[17] is GPoint(16777216, 16777216).

GNavLabelControl()

GOverlay()

This class can also be used to create custom overlays, in which case you may need to create your own copies of the methods.

methods

copy()	Returns a new GOverlay that is a copy of this one.
hide()	Hides the overlay
initialize(map)	Used by map.addOverlay() to set up the overlay.
redraw(bool)	If the optional parameter is present and true, the overlay is redrawn.
remove()	Used by map.removeOverlay() to recover memory.
show()	Shows the overlay

Static Method

GOverlay.getZIndex(lat)

Returns a z-index value for a given latitude. It computes a z index such that overlays further south are on top of overlays further north, thus creating the 3D appearance of marker overlays.

GOverviewMapControl()

GPoint()

Constructor new GPoint(x,y)

properties

x	horizontal position
y	vertical position

methods

equals(point)	Returns true if the two points are equal.
toString	Returns a string in the format "(123,123)"

GPolyline()

Constructor new GPolyline(points, color, weight, opacity, opts)

parameters

points	An array of GLatLng() or GPoint() objects
color	String: the colour of the line in the format "#ffffff"
weight	Integer: the width of the line
opacity	Float: the opacity of the line in the range 0.0 to 1.0
opts	Object Literal: A set of GPolylineOptions

options

id	undocumented I don't know what this does.
mapsdt	undocumented I don't know what this does.
name	undocumented I don't know what this does.
geodesic	When set true, a geodesic line is drawn instead of a straight line on the screen.
clickable	When set false the clicks drop through to the underlying map.

properties
undocumented

color	The colour of the line
opacity	The opacity of the line
weight	The width of the line

If you change any of the properties, call the .redraw(true) method to cause the changes to take effect.
Now that the documented .setStrokeStyle() Method is available, there's no need to use these undocumented properties.

methods

copy()	Returns a new GPolyline that is a copy of this one.
deleteVertex(N)	Removes the specified vertex. The poly must already be addOverlay()ed to a map
disableEditing()	Cancels .enableEditing()
enableDrawing(opts)	Allows the user to contruct or modify the poly. The poly must already be addOverlay()ed to a map The options are: {maxVertices:integer, fromStart:true}
enableEditing(opts)	Allows the user to edit an existing poly. The poly must already be addOverlay()ed to a map The options are: {maxVertices:integer}
getVertex(N)	Returns a GLatLng() object specifying the location of the Nth point.
getVertexCount()	Returns the number of points in the polyline.
initialize(map)	Used by map.addOverlay() to set up the polyline.
insertVertex(N,latlng)	Inserts a new vertex.
redraw()	The polyline is redrawn. [Prior to V2.101 you had to use .redraw(true)]
remove()	Used by map.removeOverlay() to recover memory.
supportsHide()	Returns true or false indicating whether the overlay supports .hide(), .show() and .isHidden() Currently true if SVG or VML is used to draw the graphic, and false otherwise.
hide()	Hides the polyline
show()	Shows the polyline
isHidden()	returns true if the polyline is hidden
getLength()	Returns the length of the polyline in metres
getBounds(v1,v2)	Returns the bounds for the polyline as a GLatLngBounds. The undocumented optional parameters can be used to specify the vertex numbers of a section of the polyline.
setStrokeStyle(opts)	Changes the style of the poly. The poly must already be addOverlay()ed to a map. The options are: {color:string, weight:number, opacity:number}

defaults
If you omit the colour, weight or opacity, the default values will be used: "#0000ff", 5, 0.45

Static methods

fromEncoded(code,opts)

Creates a polyline from an encoded string. See The official documentation

GPolygon()

Constructor new GPolygon(points, strokeColor, strokeWeight, strokeOpacity, fillColor, fillOpacity, opts)

parameters

points	An array of GLatLng() or GPoint() objects
strokeColor	String: the colour of the boundary in the format "#ffffff"
strokeWeight	Integer: the width of the boundary
strokeOpacity	Float: the opacity of the boundary in the range 0.0 to 1.0
fillColor	String: the colour of the fill in the format "#ffffff"
fillOpacity	Float: the opacity of the fill in the range 0.0 to 1.0
opts	Object Literal: A set of GPolygonOptions

options

id	undocumented I don't know what this does.
name	undocumented I don't know what this does.
mapsdt	undocumented I don't know what this does.
outline	undocumentedBoolean: set false to switch off the boundary
clickable	When set false the clicks drop through to the underlying map.

properties
undocumented

color	The colour of the polygon fill
opacity	The opacity of the polygon fill
outline	Boolean: set to false to switch off the boundary

If you change any of the properties, call the .redraw(true) method to cause the changes to take effect.
Now that the documented .setStrokeStyle() and .setFillStyle() Methods are available, there's no need to use these undocumented properties.

methods

copy()	Returns a new GPolygon that is a copy of this one.
deleteVertex(N)	Removes the specified vertex. The poly must already be addOverlay()ed to a map
disableEditing()	Cancels .enableEditing()
enableDrawing(opts)	Allows the user to contruct or modify the poly. The poly must already be addOverlay()ed to a map The options are: {maxVertices:integer, fromStart:true}
enableEditing(opts)	Allows the user to edit an existing poly. The poly must already be addOverlay()ed to a map The options are: {maxVertices:integer}
getVertex(N)	Returns a GLatLng() object specifying the location of the Nth point.
getVertexCount()	Returns the number of points in the polyline.
initialize(map)	Used by map.addOverlay() to set up the polyline.
insertVertex(N,latlng)	Inserts a new vertex.
redraw(bool)	If the optional parameter is present and true, the polygon is redrawn.
remove()	Used by map.removeOverlay() to recover memory.
supportsHide()	Returns true or false indicating whether the overlay supports .hide(), .show() and .isHidden() Currently true if SVG or VML is used to draw the graphic, and false otherwise.
hide()	Hides the polygon
show()	Shows the polygon
isHidden()	returns true if the polygon is hidden
getArea()	Returns the area of the polygon in square metres.
getBounds()	Returns the bounds of the polygon as a GLatLngBounds
setFillStyle(opts)	Changes the fill style of the poly. The poly must already be addOverlay()ed to a map. The options are: {color:string, opacity:number}
setStrokeStyle(opts)	Changes the stroke style of the poly. The poly must already be addOverlay()ed to a map. The options are: {color:string, weight:number, opacity:number}

defaults
Although GPolygon defines defaults for strokeWeight and fillColour, it never uses them.

If you omit the strokeWeight, the stroke is not performed.

If you omit the fillColor, GPolygon sets the fill colour to the default value, "#0055ff", but then doesn't perform the fill.

The default fillOpacity is 0.25.

The defaults for strokeColour and strokeOpacity are the same as those for GPolyline: "#0000ff" and 0.45

Static methods

fromEncoded(code,opts)

Creates a polygon from an encoded string.

GProjection()

The methods provided by GProjection() are empty stubs. Any real GProjection() object would have to overwrite them with its own methods that perform the relevant calculations.

It is possible to write your own GProjection() instance that uses a non-Mercator projection, such as Gall-Peters or Mollweide, or to write a flat projection for mapping non-spherical domains by writing suitable code to replace the method stubs.
methods

fromLatLngToPixel(latlng,zoom)	Stub: Throws a an error "Required interface method not implemented"
fromPixelToLatLng(point,zoom,nofix)	Stub: Throws a an error "Required interface method not implemented"
getWrapWidth(zoom)	Returns Infinity.
tileCheckRange(point,zoom,tilesize)	Returns true.

GRoute()

methods

getDistance()	returns an Object that contains the distance information .getDistance().html is a HTML string that describes the distance in suitable units .getDistance().meters is a number indicating the distance in metres
getDuration()	returns an Object that contains the duration information .getDuration().html is a HTML string that describes the duration in suitable units .getDuration().seconds is a number indicating the estimated duration in seconds
getEndGeocode	Returns geocode information for the end point
getEndLatLng	Returns a GLatLng object specifying the end point of the actual polyline.
getNumSteps	Returns the number of steps in this route
getStartGeocode	Returns geocode information for the start point
getStep(n)	Returns a GStep() object
getSummaryHtml()	returns a HTML string containing something like "790 mi (about 12 hours 28 mins)"

GScaleControl()

If _mPreferMetric is set to true, then the metric scale is on top instead of below the feet/miles scale.

It additionally accepts an optional parameter.
parameters

a

integer

undocumented (Optional) Max length of the scale in pixels.

properties

bar	A div containing part of the graphics
cap	A div containing part of the graphics
container	A div containing all the other divs
fpsBar	A div containing part of the graphics
fpsLbl	A div containing the text for non-metric measurements
map	A reference to the map that contains this Scale
maxLength	Max length of the scale in pixels
metricBar	A div containing part of the graphics
metricLbl	A div containing the text for metric measurements

GScreenOverlay

The overlay does not capture mouse clicks. You can drag the map through the overlay. You can't, however, click on markers through the overlay.

The overlay is below the map controls, so clicks on the map controls do work.

The info window does not attempt to avoid opening underneath a GScreenOverlay.

In MSIE, the API throws the image to the DirectX AlphaImageLoader. One consequence of this is that animated gifs are inanimate in MSIE.

GScreenOverlay() accepts an indeterminate number of parameters, among which are:

parameters

image	string	URL of the image
position	GScreenPoint	position of the image on the screen
anchor	GScreenPoint	point of the scaled image which is anchored to that position
size	GScreenSize	size

methods
GScreenOverlay is a GOverlay and has all the methods of that Class, however some of those methods (e.g. .redraw()) don't actually do anything.

GScreenPoint

parameters

x	number	horizontal position
y	number	vertical position
xunits	optional string	can be "pixels" or "fraction"
yunits	optional string	can be "pixels" or "fraction"

properties

point	GPoint(x,y)
xunits	can be "pixels" or "fraction"
yunits	can be "pixels" or "fraction"

If you modify the properties, the new values only take effect the next time you addOverlay() the GScreenOverlay that uses it.

GScreenSize

parameters

x	number	width
y	number	height
xunits	optional string	can be "pixels" or "fraction"
yunits	optional string	can be "pixels" or "fraction"

properties

size	GSize(x,y)
xunits	can be "pixels" or "fraction"
yunits	can be "pixels" or "fraction"

If you modify the properties, the new values only take effect the next time you addOverlay() the GScreenOverlay that uses it.

GSize()

Constructor new GSize(width, height)
properties

width	Width in pixels.
height	Height in pixels

methods

equals(gsize)	Returns true if the GSize() objects are equal.
toString()	Returns a string in the format "(123,123)"
getHeightString()	undocumented Returns the height in the format "123px"
getWidthString()	undocumented Returns the width in the format "123px"

There is also a class property GSize.ZERO, which constructs a new GSize() object with zero height and width.

GSmallMapControl()

GSmallZoomControl()

GSmallZoomControl3D()

GScript()

This function loads a Javscript file into the current page.

parameters

url	URL of the .js file to be loaded

GStreetviewClient()

Constructor
new GStreetviewClient(client)
The optional parameter is a string which defaults to "api".

properties
A GStreetviewClient() has no accessible properties

methods

getNearestPanorama(latlng,callback)	Returns full details of the Streetview location to the callback function.
getNearestPanoramaLatLng(latlng,callback)	Returns the latlng of the Streetview location, or null
getPanoramaById(id,callback)	Returns full details of the Streetview location to the callback function.

reply
The full details reply may look like this: In APIv2.103, the "copyright", "location" and "links" elements are absent.

code	Status code. 200 is supposed to mean success, but a reply may well contain only a success code and no further details
Data.copyright	undocumented Copyright text
location.description	Description of the location
location.latlng	GLatLng of the actual view point.
location.panoId	ID of the panorama
location.pov	Initial point of view
location.zoomLevels	undocumented Number of zoom levels
Links	undocumented Array of up to two adjacent View points
copyright	Copy of .Data.copyright
Location	Copy of .location
links	Copy of .Links

The Links information looks like this:

description	Description of the adjacent location
panoId	Panorama ID of the adjacent location
yawDeg	bearing to the adjacent location

The panorama has a yellow band which points in the "yawDeg" directions, is labelled with the "description" texts and clicking on the arrows moves to the viewpoint specified by the corresponding "panoId".

GStreetviewOverlay()

Constructor
new GStreetviewOverlay()

properties
A GStreetviewOverlay() has no accessible properties

methods

costructor(tilelayer)	undocumented This might not be a real Method, it may be a weird back reference from an instance to its constructor.
copy()	Returns a new GTileLayerOverlay that is a copy of this one.
getTileLayer()	undocumented Returns a reference to the GTileLayer()
hide()	Hides the overlay
initialize(map)	Used by map.addOverlay() to set up the overlay.
isHidden()	returns true if the overlay is hidden
redraw()	Does nothing.
refresh()	undocumented Performs a .refresh() on the GTileLayerOverlay
remove()	Used by map.removeOverlay() to recover memory.
show()	Unhides the overlay
supportsHide()	Returns true, thus indicating that the overlay supports .hide(), .show() and .isHidden()

GStreetviewPanorama()

Constructor
new GStreetviewPanorama(container,client/options)

parameters

The fist parameter is the HTML element, typically a <div>, in which the panorama is to be displayed.

In v2.103, the second paramter is optional "context", and defaults to "api"

In v2.104 onwards, the second paramter is optional set of options. The options can include {latlng}, {pov} and {context}. The context defaults to "api", the pov defaults to {yaw:0,pitch:5,zoom:0}. If the {latlng} is absent, the panorama it not initiated until one of the .setLocation methods is used.

properties
A GStreetviewPanorama() has no accessible properties

methods

blur()	undocumented Removes the input focus from the panorama. The view will no longer respond to key presses
checkResize()	Call this if the size of the container changes
focus()	undocumented Applies the input focus to the panorama. The view will respond to the arrow keys, page up, page down, plus and minus.
followLink(bearing)	Follows the link to the next panorama that's closest to the requested bearing Doesn't seem to work when testing locally.
getPOV	Returns an anonymous POV object which contains {pitch: yaw: zoom:} information. NOTE: When testing locally, this is the initial point of view that you requested, it doesn't reflect movements performed by the user within the Flash. When testing on a real web site, it does reflect movements performed by the user within the Flash.
hide()	Hides the panorama. Doesn't seem to work when testing locally.
isHidden()	Returns true is the panoram is hidden.
panTo(POV,longWayRound)	Pans to the specified point of view. The first parameter is a POV object which may contain some or all of {pitch: yaw: zoom: viewHeight:} If the second parameter is true, it yaws the long way round (performing a 360 degree spin if the yaw was already correct). Doesn't seem to work when testing locally.
remove()	Deletes the current panorama. You must call .remove() before setting a new location. It is safe to call .remove() on a panorama which is alrady removed. You should call .remove() before closing the container or exiting the page, otherwise the memory used by the Flash Player will not be recovered in some browsers.
retarget(container)	undocumented Removes the current panorama, and changes the container in which the panoramas will be displayed.
setContainer()	Performs a .retarget(), then redisplays the current panorama in the new container
setLocationAndPOV(latlng,POV)	Sets the panorama view. The first parameter is a GLatLng. The second optional parameter is a POV object which may contain some or all of {pitch: yaw: zoom: viewHeight:}
setLocationAndPOVFromServer Response(reply,POV)	undocumented Sets the panorama view. The first parameter is a reply from GStreetviewClient(). Only the panoId is used. The second optional parameter is a POV object which may contain some or all of {pitch: yaw: zoom: viewHeight:}
setPOV(POV)	Jumps to the specified point of view. The parameter is a POV object which may contain some or all of {pitch: yaw: zoom: viewHeight:} Doesn't seem to work when testing locally.
show()	Performs an .unhide() then redisplays the panorama. It's the opposite of .remove()
unhide()	undocumented Displays a panorama that was hidden with .hide(), but not .remove()d

POV

Describes the point of view from the Viewpoint. The parameters are

pitch	Elevation angle of the view direction. Default=5
yaw	Bearing of the view direction, 0=looking North. Default=0
zoom	Zoom level. Default=0
viewHeight	undocumented Not used? Default=0

All the parameters are optional.

Event	Returns
error	error code
yawchanged	yaw
pitchchanged	pitch
zoomchanged	zoom
flashstart	undocumented none
flashresponse	undocumented string, see below
initialized	object, see below
infolevel	undocumented ?? don't know

The "yawchanges", "pitchchanged" and "zoomchanged" events trigger when the corresponding parameter changes.

The "flashstart" event triggers when Flash Player is launched.

I think the "flashresponse" triggers when new information is received from the panorama server, but I don't understand what provokes the exchange of information.

The "initialized" event triggers when the viewpoint moves to a new location (but not when the moved by GStreetviewPanorama.setLocationAndPOV). It triggers when the user moves the viewpoint along the street, and when GStreetviewPanorama.followLink() is used.

I don't know what causes the "infolevel" event to trigger.

The "flashresponse" string looks something like this: "324:1,325:39.740116;-104.987404,327:119768;6,322:1;1".

It looks like it breaks down into a series of sections separated by commas. Each section is formatted like tag:value;value. The only one I can recognise is tag 325 which contains the latitude and longitude.

The object returned from the "initialized" event contains the following properties:

description	String: name of street.
lat	number: latitude
lng	number: longitude
latlng	GLatLng object
panoId	string: panorama ID
pov	POV object. The zoom: and pitch: elements are always void, even if the panorama is zoomed and pitched
streetRange	string: ?
yaw	number

GTileLayer()

Some or all of the methods provided by the GMapType() class need to be overwritten by code specific to the tile layer when defining the GTileLayer() object.
Constructor new GTileLayer(copyCollection,minResolution,maxResolution)

parameters

copyCollection	A GCopyrightCollection() object
minResolution	The minimum zoom level
maxResolution	The maximum zoom level

The API code seems to be intended to allow you to omit the copyCollection parameter, but if you do, the code will crash later, so you need to create some sort of GCopyrightCollection(), even if you never use it. E.g. new GTileLayer(new GCopyrightCollection(""), 7, 14) sets up a tile layer which supports zoom levels 7 to 14.

methods

getCopyright(latlngbounds,zoom)	Reads data from the GCopyrightCollection
getOpacity()	Returns 1
getTileUrl(tile,zoom)	Stub: Throws a an error "Required interface method not implemented" The "tile" parameter is a GPoint(x,y) object, but the x and y represent tile numbers, not pixels.
isPng()	Returns false
maxResolution()	Returns the maximum resolution of the layer
minResolution()	Returns the minimum resolution of the layer
getCopyrights(latlngbounds,zoom)	Returns copyright information.

GStep()

methods

getDescriptionHtml()	Returns a HTML string containing the driving instructions.
getDistance()	returns an Object that contains the distance information .getDistance().html is a HTML string that describes the distance in suitable units .getDistance().meters is a number indicating the distance in metres
getDuration()	returns an Object that contains the duration information .getDuration().html is a HTML string that describes the duration in suitable units .getDuration().seconds is a number indicating the estimated duration in seconds
getLatLng	Returns a GLatLng object specifying the location of the step.
getPolylineIndex	Returns a number which indicates the corresponding Vertex number in the polyline

GTileLayerOverlay()

Constructor
new GTileLayerOverlay(tilelayer,opts)

parameters

tile layer	The GTileLayer() object to be used as an overlay.
opts	Currently the only option is {zPriority} whicha can be used to set the z-index. Defaults to 10

properties

zPriority

undocumented z-index relative to other elements on this Pane

methods

copy()	Returns a new GTileLayerOverlay that is a copy of this one.
initialize(map)	Used by map.addOverlay() to set up the GTileLayerOverlay.
redraw(bool)	Does nothing.
remove()	Used by map.removeOverlay() to recover memory.
supportsHide()	Returns false, thus indicating that the overlay does not support .hide(), .show() and .isHidden()
getTileLayer()	Returns a reference to the GTileLayer associated with this overlay
refresh()	Causes all the tileUrls to be recalculated and the tile layer to be redrawn.

GTrafficOverlay

Constructor new GTrafficOverlay()

Use map.addOverlay() to add the overlay to the map.

methods

initialize(map)	Used by map.addOverlay() to set up the overlay.
redraw(bool)	Redraws the overlay.
remove()	Used by map.removeOverlay() to recover memory.
disableTrafficButton()	Stops the traffic button being displayed alongside the map type control.
disableTrafficLayer()	Disables the traffic layer.
enableTrafficButton()	Displays the traffic button alongside the map type control
enableTrafficLayer()	Causes the traffic layer to be displayed.
trafficButtonEnabled()	Returns true if the traffic button is enabled
trafficLayerEnabled()	Returns true if the traffic layer is enabled
hasTrafficInView()	Returns true if there is trafic data within the current viewport. Note: There's a lag between the map movement and the availability of this information. Don't try to use it within a map "moveend" listener.

By default, the traffic button is enabled and the layer is disabled. Clicking the button enables and disables the traffic layer.

The .copy(), .hide() and .show() methods also exist, but they simply throw a "Interface not implemented" error.

GUnload()

Typically, use <body onunload="GUnload()"> to avoid memory leaks.

GUnloadApi()

GUnload() is included in the API loader, rather than the main API code, and behaves sensibly in situations where the main API code has not been laoded, e.g. if the browser was found to be not compatible.

GValidateKey()

This function performs API key validation.

Hashes various subsets and variations of the current windows.location information. If one of the hashes matches the key has it returns true.
parameters

a

string

Key hash (typically provided by the API loader code)

GVerify()

I've no idea what this is intended to do.

parameters

a

string

URL of an image file.

GXmlHttp()

methods

create()	Creates a new ActiveXObject("Microsoft.XMLHTTP") or a new XMLHttpRequest() depending on the browser environment.

GXml()

GXslt()

Back to Mike's Homepage
Up to the start of this tutorial