Map(mapDiv:Node, opts?:MapOptions)

Creates a new map inside of the given HTML container, which is typically a DIV element.

用给定的容器新建地图, 常用的是 DIV.

fitBounds(bounds:LatLngBounds)

None

Sets the viewport to contain the given bounds.

getBounds()

LatLngBounds

Returns the lat/lng bounds of the current viewport. If more than one copy of the world is visible, the bounds range in longitude from -180 to 180 degrees inclusive. If the map is not yet initialized (i.e. the mapType is still null), or center and zoom have not been set then the result is null or undefined.

getCenter()

LatLng

Returns the position displayed at the center of the map. Note that thisLatLng object is not wrapped. See LatLng for more information.

getDiv()

Node

getHeading()

number

Returns the compass heading of aerial imagery. The heading value is measured in degrees (clockwise) from cardinal direction North.

getMapTypeId()

MapTypeId|string

getProjection()

Projection

Returns the current Projection. If the map is not yet initialized (i.e. the mapType is still null) then the result is null. Listen toprojection_changed and check its value to ensure it is not null.

getStreetView()

StreetViewPanorama

Returns the default StreetViewPanorama bound to the map, which may be a default panorama embedded within the map, or the panorama set using setStreetView(). Changes to the map's streetViewControl will be reflected in the display of such a bound panorama.

getTilt()

number

Returns the current angle of incidence of the map, in degrees from the viewport plane to the map plane. The result will be 0 for imagery taken directly overhead or 45 for 45° imagery. 45° imagery is only available for SATELLITE and HYBRID map types, within some locations, and at some zoom levels. Note: This method does not return the value set bysetTilt. See setTilt for details.

getZoom()

number

panBy(x:number, y:number)

None

Changes the center of the map by the given distance in pixels. If the distance is less than both the width and height of the map, the transition will be smoothly animated. Note that the map coordinate system increases from west to east (for x values) and north to south (for y values).

panTo(latLng:LatLng|LatLngLiteral)

None

Changes the center of the map to the given LatLng. If the change is less than both the width and height of the map, the transition will be smoothly animated.

panToBounds(latLngBounds:LatLngBounds)

None

Pans the map by the minimum amount necessary to contain the givenLatLngBounds. It makes no guarantee where on the map the bounds will be, except that as much of the bounds as possible will be visible. The bounds will be positioned inside the area bounded by the map type and navigation (pan, zoom, and Street View) controls, if they are present on the map. If the bounds is larger than the map, the map will be shifted to include the northwest corner of the bounds. If the change in the map's position is less than both the width and height of the map, the transition will be smoothly animated.

setCenter(latlng:LatLng|LatLngLiteral)

None

setHeading(heading:number)

None

Sets the compass heading for aerial imagery measured in degrees from cardinal direction North.

setMapTypeId(mapTypeId:MapTypeId|string)

None

setOptions(options:MapOptions)

None

setStreetView(panorama:StreetViewPanorama)

None

Binds a StreetViewPanorama to the map. This panorama overrides the default StreetViewPanorama, allowing the map to bind to an external panorama outside of the map. Setting the panorama to null binds the default embedded panorama back to the map.

setTilt(tilt:number)

None

Controls the automatic switching behavior for the angle of incidence of the map. The only allowed values are 0 and 45. setTilt(0) causes the map to always use a 0° overhead view regardless of the zoom level and viewport. setTilt(45) causes the tilt angle to automatically switch to 45 whenever 45° imagery is available for the current zoom level and viewport, and switch back to 0 whenever 45° imagery is not available (this is the default behavior). 45° imagery is only available for SATELLITE and HYBRID map types, within some locations, and at some zoom levels. Note: getTilt returns the current tilt angle, not the value set by setTilt. Because getTilt and setTilt refer to different things, do not bind() the tilt property; doing so may yield unpredictable effects.

setZoom(zoom:number)

None

controls

Array.<MVCArray.<Node>>

Additional controls to attach to the map. To add a control to the map, add the control's <div> to theMVCArray corresponding to the ControlPosition where it should be rendered.

data

Data

An instance of Data, bound to the map. Add features to this Data object to conveniently display them on this map.

mapTypes

MapTypeRegistry

A registry of MapType instances by string ID.

overlayMapTypes

MVCArray.<MapType>

Additional map types to overlay.

bounds_changed

None

This event is fired when the viewport bounds have changed.

center_changed

None

This event is fired when the map center property changes.

click

MouseEvent

This event is fired when the user clicks on the map (but not when they click on a marker or infowindow).

dblclick

MouseEvent

This event is fired when the user double-clicks on the map. Note that the click event will also fire, right before this one.

drag

None

This event is repeatedly fired while the user drags the map.

dragend

None

This event is fired when the user stops dragging the map.

dragstart

None

This event is fired when the user starts dragging the map.

heading_changed

None

This event is fired when the map heading property changes.

idle

None

This event is fired when the map becomes idle after panning or zooming.

maptypeid_changed

None

This event is fired when the mapTypeId property changes.

mousemove

MouseEvent

This event is fired whenever the user's mouse moves over the map container.

mouseout

MouseEvent

This event is fired when the user's mouse exits the map container.

mouseover

MouseEvent

This event is fired when the user's mouse enters the map container.

projection_changed

None

This event is fired when the projection has changed.

resize

None

Developers should trigger this event on the map when the div changes size:google.maps.event.trigger(map, 'resize') .

rightclick

MouseEvent

This event is fired when the DOM contextmenu event is fired on the map container.

tilesloaded

None

This event is fired when the visible tiles have finished loading.

tilt_changed

None

This event is fired when the map tilt property changes.

zoom_changed

None

This event is fired when the map zoom property changes.

backgroundColor

string

Color used for the background of the Map div. This color will be visible when tiles have not yet loaded as the user pans. This option can only be set when the map is initialized.

center

LatLng

The initial Map center. Required.

disableDefaultUI

boolean

Enables/disables all default UI. May be overridden individually.

disableDoubleClickZoom

boolean

Enables/disables zoom and center on double click. Enabled by default.

draggable

boolean

If false, prevents the map from being dragged. Dragging is enabled by default.

draggableCursor

string

The name or url of the cursor to display when mousing over a draggable map. This property uses the css cursor attribute to change the icon. As with the css property, you must specify at least one fallback cursor that is not a URL. For example: draggableCursor: 'url(http://www.example.com/icon.png), auto;'.

draggingCursor

string

The name or url of the cursor to display when the map is being dragged. This property uses the css cursor attribute to change the icon. As with the css property, you must specify at least one fallback cursor that is not a URL. For example: draggingCursor: 'url(http://www.example.com/icon.png), auto;'.

heading

number

The heading for aerial imagery in degrees measured clockwise from cardinal direction North. Headings are snapped to the nearest available angle for which imagery is available.

keyboardShortcuts

boolean

If false, prevents the map from being controlled by the keyboard. Keyboard shortcuts are enabled by default.

mapMaker

boolean

True if Map Maker tiles should be used instead of regular tiles.

mapTypeControl

boolean

The initial enabled/disabled state of the Map type control.

mapTypeControlOptions

MapTypeControlOptions

The initial display options for the Map type control.

mapTypeId

MapTypeId

The initial Map mapTypeId. Defaults to ROADMAP.

maxZoom

number

The maximum zoom level which will be displayed on the map. If omitted, or set to null, the maximum zoom from the current map type is used instead.

minZoom

number

The minimum zoom level which will be displayed on the map. If omitted, or set to null, the minimum zoom from the current map type is used instead.

noClear

boolean

If true, do not clear the contents of the Map div.

overviewMapControl

boolean

The enabled/disabled state of the Overview Map control.

overviewMapControlOptions

OverviewMapControlOptions

The display options for the Overview Map control.

panControl

boolean

The enabled/disabled state of the Pan control.

panControlOptions

PanControlOptions

The display options for the Pan control.

rotateControl

boolean

The enabled/disabled state of the Rotate control.

rotateControlOptions

RotateControlOptions

The display options for the Rotate control.

scaleControl

boolean

The initial enabled/disabled state of the Scale control.

scaleControlOptions

ScaleControlOptions

The initial display options for the Scale control.

scrollwheel

boolean

If false, disables scrollwheel zooming on the map. The scrollwheel is enabled by default.

streetView

StreetViewPanorama

A StreetViewPanorama to display when the Street View pegman is dropped on the map. If no panorama is specified, a default StreetViewPanorama will be displayed in the map's div when the pegman is dropped.

streetViewControl

boolean

The initial enabled/disabled state of the Street View Pegman control. This control is part of the default UI, and should be set to false when displaying a map type on which the Street View road overlay should not appear (e.g. a non-Earth map type).

streetViewControlOptions

StreetViewControlOptions

The initial display options for the Street View Pegman control.

styles

Array.<MapTypeStyle>

Styles to apply to each of the default map types. Note that for Satellite/Hybrid and Terrain modes, these styles will only apply to labels and geometry.

tilt

number

Controls the automatic switching behavior for the angle of incidence of the map. The only allowed values are 0 and 45. The value 0 causes the map to always use a 0° overhead view regardless of the zoom level and viewport. The value 45 causes the tilt angle to automatically switch to 45 whenever 45° imagery is available for the current zoom level and viewport, and switch back to 0 whenever 45° imagery is not available (this is the default behavior). 45° imagery is only available forSATELLITE and HYBRID map types, within some locations, and at some zoom levels. Note: getTilt returns the current tilt angle, not the value specified by this option. Because getTilt and this option refer to different things, do not bind()the tilt property; doing so may yield unpredictable effects.

zoom

number

The initial Map zoom level. Required.

zoomControl

boolean

The enabled/disabled state of the Zoom control.

zoomControlOptions

ZoomControlOptions

The display options for the Zoom control.

HYBRID

This map type displays a transparent layer of major streets on satellite images.

ROADMAP

This map type displays a normal street map.

SATELLITE

This map type displays satellite images.

TERRAIN

This map type displays maps with physical features such as terrain and vegetation.

mapTypeIds

Array.<MapTypeId>|Array.<string>

IDs of map types to show in the control.

position

ControlPosition

Position id. Used to specify the position of the control on the map. The default position isTOP_RIGHT.

style

MapTypeControlStyle

Style id. Used to select what style of map type control to display.

DEFAULT

Uses the default map type control. The control which DEFAULT maps to will vary according to window size and other factors. It may change in future versions of the API.

DROPDOWN_MENU

A dropdown menu for the screen realestate conscious.

HORIZONTAL_BAR

The standard horizontal radio buttons bar.

opened

boolean

Whether the control should display in opened mode or collapsed (minimized) mode. By default, the control is closed.

position

ControlPosition

Position id. Used to specify the position of the control on the map. The default position is TOP_LEFT.

position

ControlPosition

Position id. Used to specify the position of the control on the map. The default position is TOP_LEFT.

style

ScaleControlStyle

Style id. Used to select what style of scale control to display.

DEFAULT

The standard scale control.

position

ControlPosition

Position id. Used to specify the position of the control on the map. The default position is embedded within the navigation (zoom and pan) controls. If this position is empty or the same as that specified in thezoomControlOptions or panControlOptions, the Street View control will be displayed as part of the navigation controls. Otherwise, it will be displayed separately.

position

ControlPosition

Position id. Used to specify the position of the control on the map. The default position is TOP_LEFT.

style

ZoomControlStyle

Style id. Used to select what style of zoom control to display.

DEFAULT

The default zoom control. The control which DEFAULT maps to will vary according to map size and other factors. It may change in future versions of the API.

LARGE

The larger control, with the zoom slider in addition to +/- buttons.

SMALL

A small control with buttons to zoom in and out.

BOTTOM_CENTER

Elements are positioned in the center of the bottom row.

BOTTOM_LEFT

Elements are positioned in the bottom left and flow towards the middle. Elements are positioned to the right of the Google logo.

BOTTOM_RIGHT

Elements are positioned in the bottom right and flow towards the middle. Elements are positioned to the left of the copyrights.

LEFT_BOTTOM

Elements are positioned on the left, above bottom-left elements, and flow upwards.

LEFT_CENTER

Elements are positioned in the center of the left side.

LEFT_TOP

Elements are positioned on the left, below top-left elements, and flow downwards.

RIGHT_BOTTOM

Elements are positioned on the right, above bottom-right elements, and flow upwards.

RIGHT_CENTER

Elements are positioned in the center of the right side.

RIGHT_TOP

Elements are positioned on the right, below top-right elements, and flow downwards.

TOP_CENTER

Elements are positioned in the center of the top row.

TOP_LEFT

Elements are positioned in the top left and flow towards the middle.

TOP_RIGHT

Elements are positioned in the top right and flow towards the middle.

Data(options?:Data.DataOptions)

Creates an empty collection, with the given DataOptions.

add(feature:Data.Feature|Data.FeatureOptions)

Data.Feature

Adds a feature to the collection, and returns the added feature.

If the feature has an ID, it will replace any existing feature in the collection with the same ID. If no feature is given, a new feature will be created with null geometry and no properties. If FeatureOptionsare given, a new feature will be created with the specified properties.

addGeoJson(geoJson:Object, options?:Data.GeoJsonOptions)

Array.<Data.Feature>

Adds GeoJSON features to the collection. Give this method a parsed JSON. The imported features are returned. Throws an exception if the GeoJSON could not be imported.

contains(feature:Data.Feature)

boolean

Checks whether the given feature is in the collection.

forEach(callback:function(Data.Feature))

None

Repeatedly invokes the given function, passing a feature in the collection to the function on each invocation. The order of iteration through the features is undefined.

getFeatureById(id:string)

Data.Feature|undefined

Returns the feature with the given ID, if it exists in the collection. Otherwise returns undefined.

getMap()

Map

Returns the map on which the features are displayed.

getStyle()

Data.StylingFunction|Data.StyleOptions

Gets the style for all features in the collection.

loadGeoJson(url:string, options?:Data.GeoJsonOptions)

None

Loads GeoJSON from a URL, and adds the features to the collection.

overrideStyle(feature:Data.Feature, style:Data.StyleOptions)

None

Changes the style of a feature. These changes are applied on top of the style specified bysetStyle(). Style properties set to null revert to the value specified via setStyle().

remove(feature:Data.Feature)

None

Removes a feature from the collection.

revertStyle(feature?:Data.Feature)

None

Removes the effect of previousoverrideStyle() calls. The style of the given feature reverts to the style specified by setStyle().

If no feature is given, all features have their style reverted.

setMap(map:Map)

None

Renders the features on the specified map. If map is set to null, the features will be removed from the map.

setStyle(style:Data.StylingFunction|Data.StyleOptions)

None

Sets the style for all features in the collection. Styles specified on a per-feature basis viaoverrideStyle() continue to apply.

Pass either an object with the desired style options, or a function that computes the style for each feature. The function will be called every time a feature's properties are updated.

addfeature

Data.AddFeatureEvent

This event is fired when a feature is added to the collection.

click

Data.MouseEvent

This event is fired for a click on the geometry.

dblclick

Data.MouseEvent

This event is fired for a double click on the geometry.

mousedown

Data.MouseEvent

This event is fired for a mousedown on the geometry.

mouseout

Data.MouseEvent

This event is fired when the mouse leaves the area of the geometry.

mouseover

Data.MouseEvent

This event is fired when the mouse enters the area of the geometry.

mouseup

Data.MouseEvent

This event is fired for a mouseup on the geometry.

removefeature

Data.RemoveFeatureEvent

This event is fired when a feature is removed from the collection.

removeproperty

Data.RemovePropertyEvent

This event is fired when a feature's property is removed.

rightclick

Data.MouseEvent

This event is fired for a rightclick on the geometry.

setgeometry

Data.SetGeometryEvent

This event is fired when a feature's geometry is set.

setproperty

Data.SetPropertyEvent

This event is fired when a feature's property is set.

map

Map

Map on which to display the features in the collection.

style

Data.StylingFunction|Data.StyleOptions

Style for all features in the collection. For more details, see the setStyle() method above.

idPropertyName

string

The name of the Feature property to use as the feature ID. If not specified, the GeoJSON Feature id will be used.

clickable

boolean

If true, the marker receives mouse and touch events. Default value is true.

cursor

string

Mouse cursor to show on hover. Only applies to point geometries.

fillColor

string

The fill color. All CSS3 colors are supported except for extended named colors. Only applies to polygon geometries.

fillOpacity

number

The fill opacity between 0.0 and 1.0. Only applies to polygon geometries.

icon

string|Icon|Symbol

Icon for the foreground. If a string is provided, it is treated as though it were an Icon with the string asurl. Only applies to point geometries.

shape

MarkerShape

Defines the image map used for hit detection. Only applies to point geometries.

strokeColor

string

The stroke color. All CSS3 colors are supported except for extended named colors. Only applies to line and polygon geometries.

strokeOpacity

number

The stroke opacity between 0.0 and 1.0. Only applies to line and polygon geometries.

strokeWeight

number

The stroke width in pixels. Only applies to line and polygon geometries.

title

string

Rollover text. Only applies to point geometries.

visible

boolean

Whether the feature is visible. Defaults to true.

zIndex

number

All features are displayed on the map in order of their zIndex, with higher values displaying in front of features with lower values. Markers are always displayed in front of line-strings and polygons.

Data.Feature(options?:Data.FeatureOptions)

Constructs a Feature with the given options.

forEachProperty(callback:function(*, string))

None

Repeatedly invokes the given function, passing a property value and name on each invocation. The order of iteration through the properties is undefined.

getGeometry()

Data.Geometry

Returns the feature's geometry.

getId()

string|undefined

Returns the feature ID.

getProperty(name:string)

*

Returns the value of the requested property, or undefined if the property does not exist.

removeProperty(name:string)

None

Removes the property with the given name.

setGeometry(newGeometry:Data.Geometry|LatLng|LatLngLiteral)

None

Sets the feature's geometry.

setProperty(name:string, newValue:*)

None

Sets the value of the specified property. If newValue isundefined this is equivalent to callingremoveProperty.

remove_property

Data.RemovePropertyEvent

This event is triggered when a feature's property is removed.

set_geometry

Data.SetGeometryEvent

This event is triggered when a feature's geometry is set.

set_property

Data.SetPropertyEvent

This event is triggered when a feature's property is set.

geometry

Data.Geometry|LatLng|LatLngLiteral

The feature geometry. If none is specified when a feature is constructed, the feature's geometry will be null. If a LatLng object or LatLngLiteral is given, this will be converted to a Data.Point geometry.

id

string

Feature ID is optional. If provided, it can be used to lookup the feature in a Data object using the getFeatureById() method. Note that a feature's ID cannot be subsequently changed.

properties

Object

The feature properties. This is an arbitrary mapping of property names to values.

getType()

string

Returns the type of the geometry object. Possibilities are "Point", "MultiPoint", "LineString", "MultiLineString","LinearRing", "Polygon", "MultiPolygon", or "GeometryCollection".

Data.Point(latLng:LatLng|LatLngLiteral)

Constructs a Data.Point from the given LatLng or LatLngLiteral.

get()

LatLng

Returns the contained LatLng.

getType()

string

Returns the string "Point".

Data.MultiPoint(elements:Array.<LatLng|LatLngLiteral>)

Constructs a Data.MultiPoint from the given LatLngs or LatLngLiterals.

getArray()

Array.<LatLng>

Returns an array of the contained LatLngs. A new array is returned each time getArray() is called.

getAt(n:number)

LatLng

Returns the n-th contained LatLng.

getLength()

number

Returns the number of contained LatLngs.

getType()

string

Returns the string "MultiPoint".

Data.LineString(elements:Array.<LatLng|LatLngLiteral>)

Constructs a Data.LineString from the given LatLngs or LatLngLiterals.

getArray()

Array.<LatLng>

Returns an array of the contained LatLngs. A new array is returned each time getArray() is called.

getAt(n:number)

LatLng

Returns the n-th contained LatLng.

getLength()

number

Returns the number of contained LatLngs.

getType()

string

Returns the string "LineString".

Data.MultiLineString(elements:Array.<Data.LineString|Array.<LatLng|LatLngLiteral>>)

Constructs a Data.MultiLineString from the given Data.LineStrings or arrays of positions.

getArray()

Array.<Data.LineString>

Returns an array of the contained Data.LineStrings. A new array is returned each timegetArray() is called.

getAt(n:number)

Data.LineString

Returns the n-th contained Data.LineString.

getLength()

number

Returns the number of contained Data.LineStrings.

getType()

string

Returns the string "MultiLineString".

Data.LinearRing(elements:Array.<LatLng|LatLngLiteral>)

Constructs a Data.LinearRing from the given LatLngs or LatLngLiterals.

getArray()

Array.<LatLng>

Returns an array of the contained LatLngs. A new array is returned each time getArray() is called.

getAt(n:number)

LatLng

Returns the n-th contained LatLng.

getLength()

number

Returns the number of contained LatLngs.

getType()

string

Returns the string "LinearRing".

Data.Polygon(elements:Array.<Data.LinearRing|Array.<LatLng|LatLngLiteral>>)

Constructs a Data.Polygon from the given Data.LinearRings or arrays of positions.

getArray()

Array.<Data.LinearRing>

Returns an array of the contained Data.LinearRings. A new array is returned each timegetArray() is called.

getAt(n:number)

Data.LinearRing

Returns the n-th contained Data.LinearRing.

getLength()

number

Returns the number of contained Data.LinearRings.

getType()

string

Returns the string "Polygon".

Data.MultiPolygon(elements:Array.<Data.Polygon|Array.<Data.LinearRing|Array.<LatLng|LatLngLiteral>>>)

Constructs a Data.MultiPolygon from the givenData.Polygons or arrays of positions.

getArray()

Array.<Data.Polygon>

Returns an array of the contained Data.Polygons. A new array is returned each time getArray() is called.

getAt(n:number)

Data.Polygon

Returns the n-th contained Data.Polygon.

getLength()

number

Returns the number of contained Data.Polygons.

getType()

string

Returns the string "MultiPolygon".

Data.GeometryCollection(elements:Array.<Data.Geometry|LatLng|LatLngLiteral>)

Constructs a Data.GeometryCollection from the given geometry objects or LatLngs.

getArray()

Array.<Data.Geometry>

Returns an array of the contained geometry objects. A new array is returned each time getArray()is called.

getAt(n:number)

Data.Geometry

Returns the n-th contained geometry object.

getLength()

number

Returns the number of contained geometry objects.

getType()

string

Returns the string "GeometryCollection".

feature

Data.Feature

The feature which generated the mouse event.

feature

Data.Feature

The feature that was added to the FeatureCollection.

feature

Data.Feature

The feature that was removed from the FeatureCollection.

feature

Data.Feature

The feature whose geometry was set.

newGeometry

Data.Geometry

The new feature geometry.

oldGeometry

Data.Geometry

The previous feature geometry.

feature

Data.Feature

The feature whose property was set.

name

string

The property name.

newValue

*

The new value.

oldValue

*

The previous value. Will be undefined if the property was added.

feature

Data.Feature

The feature whose property was removed.

name

string

The property name.

oldValue

*

The previous value.

Marker(opts?:MarkerOptions)

Creates a marker with the options specified. If a map is specified, the marker is added to the map upon construction. Note that the position must be set for the marker to display.

getAnimation()

Animation

getClickable()

boolean

getCursor()

string

getDraggable()

boolean

getIcon()

string|Icon|Symbol

getMap()

Map|StreetViewPanorama

getOpacity()

number

getPosition()

LatLng

getShape()

MarkerShape

getTitle()

string

getVisible()

boolean

getZIndex()

number

setAnimation(animation:Animation)

None

Start an animation. Any ongoing animation will be cancelled. Currently supported animations are: BOUNCE, DROP. Passing innull will cause any animation to stop.

setClickable(flag:boolean)

None

setCursor(cursor:string)

None

setDraggable(flag:boolean)

None

setIcon(icon:string|Icon|Symbol)

None

setMap(map:Map|StreetViewPanorama)

None

Renders the marker on the specified map or panorama. If map is set to null, the marker will be removed.

setOpacity(opacity:number)

None

setOptions(options:MarkerOptions)

None

setPosition(latlng:LatLng|LatLngLiteral)

None

setShape(shape:MarkerShape)

None

setTitle(title:string)

None

setVisible(visible:boolean)

None

setZIndex(zIndex:number)

None

MAX_ZINDEX

The maximum default z-index that the API will assign to a marker. You may set a higher z-index to bring a marker to the front.

animation_changed

None

This event is fired when the marker's animation property changes.

click

MouseEvent

This event is fired when the marker icon was clicked.

clickable_changed

None

This event is fired when the marker's clickable property changes.

cursor_changed

None

This event is fired when the marker's cursor property changes.

dblclick

MouseEvent

This event is fired when the marker icon was double clicked.

drag

MouseEvent

This event is repeatedly fired while the user drags the marker.

dragend

MouseEvent

This event is fired when the user stops dragging the marker.

draggable_changed

None

This event is fired when the marker's draggable property changes.

dragstart

MouseEvent

This event is fired when the user starts dragging the marker.

flat_changed

None

This event is fired when the marker's flat property changes.

icon_changed

None

This event is fired when the marker icon property changes.

mousedown

MouseEvent

This event is fired for a mousedown on the marker.

mouseout

MouseEvent

This event is fired when the mouse leaves the area of the marker icon.

mouseover

MouseEvent

This event is fired when the mouse enters the area of the marker icon.

mouseup

MouseEvent

This event is fired for a mouseup on the marker.

position_changed

None

This event is fired when the marker position property changes.

rightclick

MouseEvent

This event is fired for a rightclick on the marker.

shape_changed

None

This event is fired when the marker's shape property changes.

title_changed

None

This event is fired when the marker title property changes.

visible_changed

None

This event is fired when the marker's visible property changes.

zindex_changed

None

This event is fired when the marker's zIndex property changes.

anchorPoint

Point

The offset from the marker's position to the tip of an InfoWindow that has been opened with the marker as anchor.

animation

Animation

Which animation to play when marker is added to a map.

clickable

boolean

If true, the marker receives mouse and touch events. Default value is true.

crossOnDrag

boolean

If false, disables cross that appears beneath the marker when dragging. This option is true by default.

cursor

string

Mouse cursor to show on hover

draggable

boolean

If true, the marker can be dragged. Default value is false.

icon

string|Icon|Symbol

Icon for the foreground. If a string is provided, it is treated as though it were an Icon with the string as url.

map

Map|StreetViewPanorama

Map on which to display Marker.

opacity

number

The marker's opacity between 0.0 and 1.0.

optimized

boolean

Optimization renders many markers as a single static element. Optimized rendering is enabled by default. Disable optimized rendering for animated GIFs or PNGs, or when each marker must be rendered as a separate DOM element (advanced usage only).

position

LatLng

Marker position. Required.

shape

MarkerShape

Image map region definition used for drag/click.

title

string

Rollover text

visible

boolean

If true, the marker is visible

zIndex

number

All markers are displayed on the map in order of their zIndex, with higher values displaying in front of markers with lower values. By default, markers are displayed according to their vertical position on screen, with lower markers appearing in front of markers further up the screen.

anchor

Point

The position at which to anchor an image in correspondance to the location of the marker on the map. By default, the anchor is located along the center point of the bottom of the image.

origin

Point

The position of the image within a sprite, if any. By default, the origin is located at the top left corner of the image (0, 0).

scaledSize

Size

The size of the entire image after scaling, if any. Use this property to stretch/shrink an image or a sprite.

size

Size

The display size of the sprite or image. When using sprites, you must specify the sprite size. If the size is not provided, it will be set when the image loads.

url

string

The URL of the image or sprite sheet.

coords

Array.<number>

The format of this attribute depends on the value of the type and follows the w3 AREA coords specification found athttp://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords. 
The coords attribute is an array of integers that specify the pixel position of the shape relative to the top-left corner of the target image. The coordinates depend on the value of type as follows: 
  - circle: coords is [x1,y1,r] where x1,y2 are the coordinates of the center of the circle, and r is the radius of the circle. 
  - poly: coords is [x1,y1,x2,y2...xn,yn] where each x,y pair contains the coordinates of one vertex of the polygon. 
  - rect: coords is [x1,y1,x2,y2] where x1,y1 are the coordinates of the upper-left corner of the rectangle and x2,y2 are the coordinates of the lower-right coordinates of the rectangle.

type

string

Describes the shape's type and can be circle, poly or rect.

anchor

Point

The position of the symbol relative to the marker or polyline. The coordinates of the symbol's path are translated left and up by the anchor's x and y coordinates respectively. By default, a symbol is anchored at (0, 0). The position is expressed in the same coordinate system as the symbol's path.

fillColor

string

The symbol's fill color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to 'black'. For symbols on polylines, this defaults to the stroke color of the corresponding polyline.

fillOpacity

number

The symbol's fill opacity. Defaults to 0.

path

SymbolPath|string

The symbol's path, which is a built-in symbol path, or a custom path expressed using SVG path notation. Required.

rotation

number

The angle by which to rotate the symbol, expressed clockwise in degrees. Defaults to 0. A symbol in anIconSequence where fixedRotation is false is rotated relative to the angle of the edge on which it lies.

scale

number

The amount by which the symbol is scaled in size. For symbol markers, this defaults to 1; after scaling, the symbol may be of any size. For symbols on a polyline, this defaults to the stroke weight of the polyline; after scaling, the symbol must lie inside a square 22 pixels in size centered at the symbol's anchor.

strokeColor

string

The symbol's stroke color. All CSS3 colors are supported except for extended named colors. For symbol markers, this defaults to 'black'. For symbols on a polyline, this defaults to the stroke color of the polyline.

strokeOpacity

number

The symbol's stroke opacity. For symbol markers, this defaults to 1. For symbols on a polyline, this defaults to the stroke opacity of the polyline.

strokeWeight

number

The symbol's stroke weight. Defaults to the scale of the symbol.

BACKWARD_CLOSED_ARROW

A backward-pointing closed arrow.

BACKWARD_OPEN_ARROW

A backward-pointing open arrow.

CIRCLE

A circle.

FORWARD_CLOSED_ARROW

A forward-pointing closed arrow.

FORWARD_OPEN_ARROW

A forward-pointing open arrow.

BOUNCE

Marker bounces until animation is stopped.

DROP

Marker falls from the top of the map ending with a small bounce.

InfoWindow(opts?:InfoWindowOptions)

Creates an info window with the given options. An InfoWindow can be placed on a map at a particular position or above a marker, depending on what is specified in the options. Unless auto-pan is disabled, an InfoWindow will pan the map to make itself visible when it is opened. After constructing an InfoWindow, you must call open to display it on the map. The user can click the close button on the InfoWindow to remove it from the map, or the developer can call close() for the same effect.

close()

None

Closes this InfoWindow by removing it from the DOM structure.

getContent()

string|Node

getPosition()

LatLng

getZIndex()

number

open(map?:Map|StreetViewPanorama, anchor?:MVCObject)

None

Opens this InfoWindow on the given map. Optionally, an InfoWindow can be associated with an anchor. In the core API, the only anchor is the Marker class. However, an anchor can be any MVCObject that exposes a LatLng positionproperty and optionally a Point anchorPoint property for calculating thepixelOffset (see InfoWindowOptions). The anchorPoint is the offset from the anchor's position to the tip of the InfoWindow.

setContent(content:string|Node)

None

setOptions(options:InfoWindowOptions)

None

setPosition(position:LatLng)

None

setZIndex(zIndex:number)

None

closeclick

None

This event is fired when the close button was clicked.

content_changed

None

This event is fired when the content property changes.

domready

None

This event is fired when the <div> containing the InfoWindow's content is attached to the DOM. You may wish to monitor this event if you are building out your info window content dynamically.

position_changed

None

This event is fired when the position property changes.

zindex_changed

None

This event is fired when the InfoWindow's zIndex changes.

content

string|Node

Content to display in the InfoWindow. This can be an HTML element, a plain-text string, or a string containing HTML. The InfoWindow will be sized according to the content. To set an explicit size for the content, set content to be a HTML element with that size.

disableAutoPan

boolean

Disable auto-pan on open. By default, the info window will pan the map so that it is fully visible when it opens.

maxWidth

number

Maximum width of the infowindow, regardless of content's width. This value is only considered if it is set before a call to open. To change the maximum width when changing content, call close, setOptions, and then open.

pixelOffset

Size

The offset, in pixels, of the tip of the info window from the point on the map at whose geographical coordinates the info window is anchored. If an InfoWindow is opened with an anchor, thepixelOffset will be calculated from the anchor's anchorPoint property.

position

LatLng|LatLngLiteral

The LatLng at which to display this InfoWindow. If the InfoWindow is opened with an anchor, the anchor's position will be used instead.

zIndex

number

All InfoWindows are displayed on the map in order of their zIndex, with higher values displaying in front of InfoWindows with lower values. By default, InfoWindows are displayed according to their latitude, with InfoWindows of lower latitudes appearing in front of InfoWindows at higher latitudes. InfoWindows are always displayed in front of markers.

Polyline(opts?:PolylineOptions)

Create a polyline using the passed PolylineOptions, which specify both the path of the polyline and the stroke style to use when drawing the polyline. You may pass either an array of LatLngs or an MVCArray ofLatLngs when constructing a polyline, though simple arrays are converted to MVCArrays within the polyline upon instantiation.

getDraggable()

boolean

Returns whether this shape can be dragged by the user.

getEditable()

boolean

Returns whether this shape can be edited by the user.

getMap()

Map

Returns the map on which this shape is attached.

getPath()

MVCArray.<LatLng>

Retrieves the first path.

getVisible()

boolean

Returns whether this poly is visible on the map.

setDraggable(draggable:boolean)

None

If set to true, the user can drag this shape over the map. The geodesic property defines the mode of dragging.

setEditable(editable:boolean)

None

If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment.

setMap(map:Map)

None

Renders this shape on the specified map. If map is set to null, the shape will be removed.

setOptions(options:PolylineOptions)

None

setPath(path:MVCArray.<LatLng>|Array.<LatLng|LatLngLiteral>)

None

Sets the first path. See PolylineOptions for more details.

setVisible(visible:boolean)

None

Hides this poly if set to false.

click

PolyMouseEvent

This event is fired when the DOM click event is fired on the Polyline.

dblclick

PolyMouseEvent

This event is fired when the DOM dblclick event is fired on the Polyline.

drag

MouseEvent

This event is repeatedly fired while the user drags the polyline.

dragend

MouseEvent

This event is fired when the user stops dragging the polyline.

dragstart

MouseEvent

This event is fired when the user starts dragging the polyline.

mousedown

PolyMouseEvent

This event is fired when the DOM mousedown event is fired on the Polyline.

mousemove

PolyMouseEvent

This event is fired when the DOM mousemove event is fired on the Polyline.

mouseout

PolyMouseEvent

This event is fired on Polyline mouseout.

mouseover

PolyMouseEvent

This event is fired on Polyline mouseover.

mouseup

PolyMouseEvent

This event is fired when the DOM mouseup event is fired on the Polyline.

rightclick

PolyMouseEvent

This event is fired when the Polyline is right-clicked on.

clickable

boolean

Indicates whether this Polyline handles mouse events. Defaults to true.

draggable

boolean

If set to true, the user can drag this shape over the map. The geodesic property defines the mode of dragging. Defaults to false.

editable

boolean

If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment. Defaults to false.

geodesic

boolean

When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. When false, edges of the polygon are rendered as straight lines in screen space. Note that the shape of a geodesic polygon may appear to change when dragged, as the dimensions are maintained relative to the surface of the earth. Defaults to false.

icons

Array.<IconSequence>

The icons to be rendered along the polyline.

map

Map

Map on which to display Polyline.

path

MVCArray.<LatLng>|Array.<LatLng|LatLngLiteral>

The ordered sequence of coordinates of the Polyline. This path may be specified using either a simple array of LatLngs, or an MVCArray of LatLngs. Note that if you pass a simple array, it will be converted to an MVCArray Inserting or removing LatLngs in the MVCArray will automatically update the polyline on the map.

strokeColor

string

The stroke color. All CSS3 colors are supported except for extended named colors.

strokeOpacity

number

The stroke opacity between 0.0 and 1.0.

strokeWeight

number

The stroke width in pixels.

visible

boolean

Whether this polyline is visible on the map. Defaults to true.

zIndex

number

The zIndex compared to other polys.

fixedRotation

boolean

If true, each icon in the sequence has the same fixed rotation regardless of the angle of the edge on which it lies. Defaults to false, in which case each icon in the sequence is rotated to align with its edge.

icon

Symbol

The icon to render on the line.

offset

string

The distance from the start of the line at which an icon is to be rendered. This distance may be expressed as a percentage of line's length (e.g. '50%') or in pixels (e.g. '50px'). Defaults to '100%'.

repeat

string

The distance between consecutive icons on the line. This distance may be expressed as a percentage of the line's length (e.g. '50%') or in pixels (e.g. '50px'). To disable repeating of the icon, specify '0'. Defaults to '0'.

Polygon(opts?:PolygonOptions)

Create a polygon using the passed PolygonOptions, which specify the polygon's path, the stroke style for the polygon's edges, and the fill style for the polygon's interior regions. A polygon may contain one or more paths, where each path consists of an array of LatLngs. You may pass either an array of LatLngs or anMVCArray of LatLngs when constructing these paths. Arrays are converted to MVCArrays within the polygon upon instantiation.

getDraggable()

boolean

Returns whether this shape can be dragged by the user.

getEditable()

boolean

Returns whether this shape can be edited by the user.

getMap()

Map

Returns the map on which this shape is attached.

getPath()

MVCArray.<LatLng>

Retrieves the first path.

getPaths()

MVCArray.<MVCArray.<LatLng>>

Retrieves the paths for this polygon.

getVisible()

boolean

Returns whether this poly is visible on the map.

setDraggable(draggable:boolean)

None

If set to true, the user can drag this shape over the map. The geodesic property defines the mode of dragging.

setEditable(editable:boolean)

None

If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment.

setMap(map:Map)

None

Renders this shape on the specified map. If map is set to null, the shape will be removed.

setOptions(options:PolygonOptions)

None

setPath(path:MVCArray.<LatLng>|Array.<LatLng|LatLngLiteral>)

None

Sets the first path. See PolylineOptions for more details.

setPaths(paths:MVCArray.<MVCArray.<LatLng>>|MVCArray.<LatLng>|Array.<Array.<LatLng|LatLngLiteral>>|Array.<LatLng|LatLngLiteral>)

None

Sets the path for this polygon.

setVisible(visible:boolean)

None

Hides this poly if set to false.

click

PolyMouseEvent

This event is fired when the DOM click event is fired on the Polygon.

dblclick

PolyMouseEvent

This event is fired when the DOM dblclick event is fired on the Polygon.

drag

MouseEvent

This event is repeatedly fired while the user drags the polygon.

dragend

MouseEvent

This event is fired when the user stops dragging the polygon.

dragstart

MouseEvent

This event is fired when the user starts dragging the polygon.

mousedown

PolyMouseEvent

This event is fired when the DOM mousedown event is fired on the Polygon.

mousemove

PolyMouseEvent

This event is fired when the DOM mousemove event is fired on the Polygon.

mouseout

PolyMouseEvent

This event is fired on Polygon mouseout.

mouseover

PolyMouseEvent

This event is fired on Polygon mouseover.

mouseup

PolyMouseEvent

This event is fired when the DOM mouseup event is fired on the Polygon.

rightclick

PolyMouseEvent

This event is fired when the Polygon is right-clicked on.

clickable

boolean

Indicates whether this Polygon handles mouse events. Defaults to true.

draggable

boolean

If set to true, the user can drag this shape over the map. The geodesic property defines the mode of dragging. Defaults to false.

editable

boolean

If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment. Defaults to false.

fillColor

string

The fill color. All CSS3 colors are supported except for extended named colors.

fillOpacity

number

The fill opacity between 0.0 and 1.0

geodesic

boolean

When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. When false, edges of the polygon are rendered as straight lines in screen space. Note that the shape of a geodesic polygon may appear to change when dragged, as the dimensions are maintained relative to the surface of the earth. Defaults to false.

map

Map

Map on which to display Polygon.

paths

MVCArray.<MVCArray.<LatLng>>|MVCArray.<LatLng>|Array.<Array.<LatLng|LatLngLiteral>>|Array.<LatLng|LatLngLiteral>

The ordered sequence of coordinates that designates a closed loop. Unlike polylines, a polygon may consist of one or more paths. As a result, the paths property may specify one or more arrays of LatLng coordinates. Paths are closed automatically; do not repeat the first vertex of the path as the last vertex. Simple polygons may be defined using a single array of LatLngs. More complex polygons may specify an array of arrays. Any simple arrays are converted into MVCArrays. Inserting or removing LatLngs from theMVCArray will automatically update the polygon on the map.

strokeColor

string

The stroke color. All CSS3 colors are supported except for extended named colors.

strokeOpacity

number

The stroke opacity between 0.0 and 1.0

strokePosition

StrokePosition

The stroke position. Defaults to CENTER. This property is not supported on Internet Explorer 8 and earlier.

strokeWeight

number

The stroke width in pixels.

visible

boolean

Whether this polygon is visible on the map. Defaults to true.

zIndex

number

The zIndex compared to other polys.

edge

number

The index of the edge within the path beneath the cursor when the event occurred, if the event occurred on a mid-point on an editable polygon.

path

number

The index of the path beneath the cursor when the event occurred, if the event occurred on a vertex and the polygon is editable. Otherwise undefined.

vertex

number

The index of the vertex beneath the cursor when the event occurred, if the event occurred on a vertex and the polyline or polygon is editable. If the event does not occur on a vertex, the value is undefined.

Rectangle(opts?:RectangleOptions)

Create a rectangle using the passed RectangleOptions, which specify the bounds and style.

getBounds()

LatLngBounds

Returns the bounds of this rectangle.

getDraggable()

boolean

Returns whether this rectangle can be dragged by the user.

getEditable()

boolean

Returns whether this rectangle can be edited by the user.

getMap()

Map

Returns the map on which this rectangle is displayed.

getVisible()

boolean

Returns whether this rectangle is visible on the map.

setBounds(bounds:LatLngBounds)

None

Sets the bounds of this rectangle.

setDraggable(draggable:boolean)

None

If set to true, the user can drag this rectangle over the map.

setEditable(editable:boolean)

None

If set to true, the user can edit this rectangle by dragging the control points shown at the corners and on each edge.

setMap(map:Map)

None

Renders the rectangle on the specified map. If map is set to null, the rectangle will be removed.

setOptions(options:RectangleOptions)

None

setVisible(visible:boolean)

None

Hides this rectangle if set to false.

bounds_changed

None

This event is fired when the rectangle's bounds are changed.

click

MouseEvent

This event is fired when the DOM click event is fired on the rectangle.

dblclick

MouseEvent

This event is fired when the DOM dblclick event is fired on the rectangle.

drag

MouseEvent

This event is repeatedly fired while the user drags the rectangle.

dragend

MouseEvent

This event is fired when the user stops dragging the rectangle.

dragstart

MouseEvent

This event is fired when the user starts dragging the rectangle.

mousedown

MouseEvent

This event is fired when the DOM mousedown event is fired on the rectangle.

mousemove

MouseEvent

This event is fired when the DOM mousemove event is fired on the rectangle.

mouseout

MouseEvent

This event is fired on rectangle mouseout.

mouseover

MouseEvent

This event is fired on rectangle mouseover.

mouseup

MouseEvent

This event is fired when the DOM mouseup event is fired on the rectangle.

rightclick

MouseEvent

This event is fired when the rectangle is right-clicked on.

bounds

LatLngBounds

The bounds.

clickable

boolean

Indicates whether this Rectangle handles mouse events. Defaults to true.

draggable

boolean

If set to true, the user can drag this rectangle over the map. Defaults to false.

editable

boolean

If set to true, the user can edit this rectangle by dragging the control points shown at the corners and on each edge. Defaults to false.

fillColor

string

The fill color. All CSS3 colors are supported except for extended named colors.

fillOpacity

number

The fill opacity between 0.0 and 1.0

map

Map

Map on which to display Rectangle.

strokeColor

string

The stroke color. All CSS3 colors are supported except for extended named colors.

strokeOpacity

number

The stroke opacity between 0.0 and 1.0

strokePosition

StrokePosition

The stroke position. Defaults to CENTER. This property is not supported on Internet Explorer 8 and earlier.

strokeWeight

number

The stroke width in pixels.

visible

boolean

Whether this rectangle is visible on the map. Defaults to true.

zIndex

number

The zIndex compared to other polys.

Circle(opts?:CircleOptions)

Create a circle using the passed CircleOptions, which specify the center, radius, and style.

getBounds()

LatLngBounds

Gets the LatLngBounds of this Circle.

getCenter()

LatLng

Returns the center of this circle.

getDraggable()

boolean

Returns whether this circle can be dragged by the user.

getEditable()

boolean

Returns whether this circle can be edited by the user.

getMap()

Map

Returns the map on which this circle is displayed.

getRadius()

number

Returns the radius of this circle (in meters).

getVisible()

boolean

Returns whether this circle is visible on the map.

setCenter(center:LatLng|LatLngLiteral)

None

Sets the center of this circle.

setDraggable(draggable:boolean)

None

If set to true, the user can drag this circle over the map.

setEditable(editable:boolean)

None

If set to true, the user can edit this circle by dragging the control points shown at the center and around the circumference of the circle.

setMap(map:Map)

None

Renders the circle on the specified map. If map is set to null, the circle will be removed.

setOptions(options:CircleOptions)

None

setRadius(radius:number)

None

Sets the radius of this circle (in meters).

setVisible(visible:boolean)

None

Hides this circle if set to false.

center_changed

None

This event is fired when the circle's center is changed.

click

MouseEvent

This event is fired when the DOM click event is fired on the circle.

dblclick

MouseEvent

This event is fired when the DOM dblclick event is fired on the circle.

drag

MouseEvent

This event is repeatedly fired while the user drags the circle.

dragend

MouseEvent

This event is fired when the user stops dragging the circle.

dragstart

MouseEvent

This event is fired when the user starts dragging the circle.

mousedown

MouseEvent

This event is fired when the DOM mousedown event is fired on the circle.

mousemove

MouseEvent

This event is fired when the DOM mousemove event is fired on the circle.

mouseout

MouseEvent

This event is fired on circle mouseout.

mouseover

MouseEvent

This event is fired on circle mouseover.

mouseup

MouseEvent

This event is fired when the DOM mouseup event is fired on the circle.

radius_changed

None

This event is fired when the circle's radius is changed.

rightclick

MouseEvent

This event is fired when the circle is right-clicked on.

center

LatLng

The center

clickable

boolean

Indicates whether this Circle handles mouse events. Defaults to true.

draggable

boolean

If set to true, the user can drag this circle over the map. Defaults to false.

editable

boolean

If set to true, the user can edit this circle by dragging the control points shown at the center and around the circumference of the circle. Defaults to false.

fillColor

string

The fill color. All CSS3 colors are supported except for extended named colors.

fillOpacity

number

The fill opacity between 0.0 and 1.0

map

Map

Map on which to display Circle.

radius

number

The radius in meters on the Earth's surface

strokeColor

string

The stroke color. All CSS3 colors are supported except for extended named colors.

strokeOpacity

number

The stroke opacity between 0.0 and 1.0

strokePosition

StrokePosition

The stroke position. Defaults to CENTER. This property is not supported on Internet Explorer 8 and earlier.

strokeWeight

number

The stroke width in pixels.

visible

boolean

Whether this circle is visible on the map. Defaults to true.

zIndex

number

The zIndex compared to other polys.

CENTER

The stroke is centered on the polygon's path, with half the stroke inside the polygon and half the stroke outside the polygon.

INSIDE

The stroke lies inside the polygon.

OUTSIDE

The stroke lies outside the polygon.

GroundOverlay(url:string, bounds:LatLngBounds, opts?:GroundOverlayOptions)

Creates a ground overlay from the provided image URL and its LatLngBounds. The image is scaled to fit the current bounds, and projected using the current map projection.

getBounds()

LatLngBounds

Gets the LatLngBounds of this overlay.

getMap()

Map

Returns the map on which this ground overlay is displayed.

getOpacity()

number

Returns the opacity of this ground overlay.

getUrl()

string

Gets the url of the projected image.

setMap(map:Map)

None

Renders the ground overlay on the specified map. If map is set to null, the overlay is removed.

setOpacity(opacity:number)

None

Sets the opacity of this ground overlay.

click

MouseEvent

This event is fired when the DOM click event is fired on the GroundOverlay.

dblclick

MouseEvent

This event is fired when the DOM dblclick event is fired on the GroundOverlay.

clickable

boolean

If true, the ground overlay can receive mouse events.

map

Map

The map on which to display the overlay.

opacity

number

The opacity of the overlay, expressed as a number between 0 and 1. Optional. Defaults to 1.

OverlayView()

Creates an OverlayView.

draw()

None

Implement this method to draw or update the overlay. This method is called after onAdd() and when the position from projection.fromLatLngToPixel() would return a new value for a given LatLng. This can happen on change of zoom, center, or map type. It is not necessarily called on drag or resize.

getMap()

Map|StreetViewPanorama

getPanes()

MapPanes

Returns the panes in which this OverlayView can be rendered. The panes are not initialized until onAdd is called by the API.

getProjection()

MapCanvasProjection

Returns the MapCanvasProjection object associated with this OverlayView. The projection is not initialized until onAdd is called by the API.

onAdd()

None

Implement this method to initialize the overlay DOM elements. This method is called once after setMap() is called with a valid map. At this point, panes and projection will have been initialized.

onRemove()

None

Implement this method to remove your elements from the DOM. This method is called once following a call to setMap(null).

setMap(map:Map|StreetViewPanorama)

None

Adds the overlay to the map or panorama.

floatPane

Node

This pane contains the info window. It is above all map overlays. (Pane 6).

floatShadow

Node

This pane contains the info window shadow. It is above the overlayImage, so that markers can be in the shadow of the info window. (Pane 4).

mapPane

Node

This pane is the lowest pane and is above the tiles. It may not receive DOM events. (Pane 0).

overlayImage

Node

This pane contains the marker foreground images. (Pane 3).

overlayLayer

Node

This pane contains polylines, polygons, ground overlays and tile layer overlays. It may not receive DOM events. (Pane 1).

overlayMouseTarget

Node

This pane contains elements that receive DOM mouse events, such as the transparent targets for markers. It is above the floatShadow, so that markers in the shadow of the info window can be clickable. (Pane 5).

overlayShadow

Node

This pane contains the marker shadows. It may not receive DOM events. (Pane 2).

fromContainerPixelToLatLng(pixel:Point, nowrap?:boolean)

LatLng

Computes the geographical coordinates from pixel coordinates in the map's container.

fromDivPixelToLatLng(pixel:Point, nowrap?:boolean)

LatLng

Computes the geographical coordinates from pixel coordinates in the div that holds the draggable map.

fromLatLngToContainerPixel(latLng:LatLng)

Point

Computes the pixel coordinates of the given geographical location in the map's container element.

fromLatLngToDivPixel(latLng:LatLng)

Point

Computes the pixel coordinates of the given geographical location in the DOM element that holds the draggable map.

getWorldWidth()

number

The width of the world in pixels in the current zoom level. For projections with a heading angle of either 90 or 270 degrees, this corresponds to the pixel span in the Y-axis.

Geocoder()

Creates a new instance of a Geocoder that sends geocode requests to Google servers.

geocode(request:GeocoderRequest, callback:function(Array.<GeocoderResult>, GeocoderStatus))

None

Geocode a request.

address

string

Address. Optional.

bounds

LatLngBounds

LatLngBounds within which to search. Optional.

location

LatLng|LatLngLiteral

LatLng about which to search. Optional.

region

string

Country code used to bias the search, specified as a Unicode region subtag / CLDR identifier. Optional.

administrativeArea

string

Matches all the administrative_area levels. Optional.

country

string

Matches a country name or a two letter ISO 3166-1 country code. Optional.

locality

string

Matches against both locality and sublocality types. Optional.

postalCode

string

Matches postal_code and postal_code_prefix. Optional.

route

string

Matches the long or short name of a route. Optional.

ERROR

There was a problem contacting the Google servers.

INVALID_REQUEST

This GeocoderRequest was invalid.

OK

The response contains a valid GeocoderResponse.

OVER_QUERY_LIMIT

The webpage has gone over the requests limit in too short a period of time.

REQUEST_DENIED

The webpage is not allowed to use the geocoder.

UNKNOWN_ERROR

A geocoding request could not be processed due to a server error. The request may succeed if you try again.

ZERO_RESULTS

No result was found for this GeocoderRequest.

address_components

Array.<GeocoderAddressComponent>

An array of GeocoderAddressComponents

formatted_address

string

A string containing the human-readable address of this location.

geometry

GeocoderGeometry

A GeocoderGeometry object

partial_match

boolean

Whether the geocoder did not return an exact match for the original request, though it was able to match part of the requested address.

postcode_localities

Array.<string>

An array of strings denoting all the localities contained in a postal code. This is only present when the result is a postal code that contains multiple localities.

types

Array.<string>

An array of strings denoting the type of the returned geocoded element. For a list of possible strings, refer to the Address Component Types section of the Developer's Guide.

long_name

string

The full text of the address component

short_name

string

The abbreviated, short text of the given address component

types

Array.<string>

An array of strings denoting the type of this address component. A list of valid types can be found here

bounds

LatLngBounds

The precise bounds of this GeocoderResult, if applicable

location

LatLng

The latitude/longitude coordinates of this result

location_type

GeocoderLocationType

The type of location returned in location

viewport

LatLngBounds

The bounds of the recommended viewport for displaying this GeocoderResult

APPROXIMATE

The returned result is approximate.

GEOMETRIC_CENTER

The returned result is the geometric center of a result such a line (e.g. street) or polygon (region).

RANGE_INTERPOLATED

The returned result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.

ROOFTOP

The returned result reflects a precise geocode.

DirectionsRenderer(opts?:DirectionsRendererOptions)

Creates the renderer with the given options. Directions can be rendered on a map (as visual overlays) or additionally on a <div> panel (as textual instructions).

getDirections()

DirectionsResult

Returns the renderer's current set of directions.

getMap()

Map

Returns the map on which the DirectionsResult is rendered.

getPanel()

Node

Returns the panel <div> in which the DirectionsResult is rendered.

getRouteIndex()

number

Returns the current (zero-based) route index in use by thisDirectionsRenderer object.

setDirections(directions:DirectionsResult)

None

Set the renderer to use the result from the DirectionsService. Setting a valid set of directions in this manner will display the directions on the renderer's designated map and panel.

setMap(map:Map)

None

This method specifies the map on which directions will be rendered. Pass null to remove the directions from the map.

setOptions(options:DirectionsRendererOptions)

None

Change the options settings of this DirectionsRenderer after initialization.

setPanel(panel:Node)

None

This method renders the directions in a <div>. Pass null to remove the content from the panel.

setRouteIndex(routeIndex:number)

None

Set the (zero-based) index of the route in the DirectionsResult object to render. By default, the first route in the array will be rendered.

directions_changed

None

This event is fired when the rendered directions change, either when a new DirectionsResult is set or when the user finishes dragging a change to the directions path.

directions

DirectionsResult

The directions to display on the map and/or in a <div> panel, retrieved as a DirectionsResultobject from DirectionsService.

draggable

boolean

If true, allows the user to drag and modify the paths of routes rendered by thisDirectionsRenderer.

hideRouteList

boolean

This property indicates whether the renderer should provide UI to select amongst alternative routes. By default, this flag is false and a user-selectable list of routes will be shown in the directions' associated panel. To hide that list, set hideRouteList to true.

infoWindow

InfoWindow

The InfoWindow in which to render text information when a marker is clicked. Existing info window content will be overwritten and its position moved. If no info window is specified, theDirectionsRenderer will create and use its own info window. This property will be ignored ifsuppressInfoWindows is set to true.

map

Map

Map on which to display the directions.

markerOptions

MarkerOptions

Options for the markers. All markers rendered by the DirectionsRenderer will use these options.

panel

Node

The <div> in which to display the directions steps.

polylineOptions

PolylineOptions

Options for the polylines. All polylines rendered by the DirectionsRenderer will use these options.

preserveViewport

boolean

By default, the input map is centered and zoomed to the bounding box of this set of directions. If this option is set to true, the viewport is left unchanged, unless the map's center and zoom were never set.

routeIndex

number

The index of the route within the DirectionsResult object. The default value is 0.

suppressBicyclingLayer

boolean

Suppress the rendering of the BicyclingLayer when bicycling directions are requested.

suppressInfoWindows

boolean

Suppress the rendering of info windows.

suppressMarkers

boolean

Suppress the rendering of markers.

suppressPolylines

boolean

Suppress the rendering of polylines.

DirectionsService()

Creates a new instance of a DirectionsService that sends directions queries to Google servers.

route(request:DirectionsRequest, callback:function(DirectionsResult,DirectionsStatus))

None

Issue a directions search request.

avoidFerries

boolean

If true, instructs the Directions service to avoid ferries where possible. Optional.

avoidHighways

boolean

If true, instructs the Directions service to avoid highways where possible. Optional.

avoidTolls

boolean

If true, instructs the Directions service to avoid toll roads where possible. Optional.

destination

LatLng|string

Location of destination. This can be specified as either a string to be geocoded or aLatLng. Required.

durationInTraffic

boolean

Whether or not we should provide trip duration based on current traffic conditions. Only available to Maps API for Business customers.

optimizeWaypoints

boolean

If set to true, the DirectionService will attempt to re-order the supplied intermediate waypoints to minimize overall cost of the route. If waypoints are optimized, inspectDirectionsRoute.waypoint_order in the response to determine the new ordering.

origin

LatLng|string

Location of origin. This can be specified as either a string to be geocoded or a LatLng. Required.

provideRouteAlternatives

boolean

Whether or not route alternatives should be provided. Optional.

region

string

Region code used as a bias for geocoding requests. Optional.

transitOptions

TransitOptions

Settings that apply only to requests where travelMode is TRANSIT. This object will have no effect for other travel modes.

travelMode

TravelMode

Type of routing requested. Required.

unitSystem

UnitSystem

Preferred unit system to use when displaying distance. Defaults to the unit system used in the country of origin.

waypoints

Array.<DirectionsWaypoint>

Array of intermediate waypoints. Directions will be calculated from the origin to the destination by way of each waypoint in this array. The maximum allowed waypoints is 8, plus the origin, and destination. Maps API for Business customers are allowed 23 waypoints, plus the origin, and destination. Waypoints are not supported for transit directions. Optional.

BICYCLING

Specifies a bicycling directions request.

DRIVING

Specifies a driving directions request.

TRANSIT

Specifies a transit directions request.

WALKING

Specifies a walking directions request.

IMPERIAL

Specifies that distances in the DirectionsResult should be expressed in imperial units.

METRIC

Specifies that distances in the DirectionsResult should be expressed in metric units.

arrivalTime

Date

The desired arrival time for the route, specified as a Date object. The Date object measures time in milliseconds since 1 January 1970. If arrival time is specified, departure time is ignored.

departureTime

Date

The desired departure time for the route, specified as a Date object. The Date object measures time in milliseconds since 1 January 1970. If neither departure time nor arrival time is specified, the time is assumed to be "now".

location

LatLng|string

Waypoint location. Can be an address string or LatLng. Optional.

stopover

boolean

If true, indicates that this waypoint is a stop between the origin and destination. This has the effect of splitting the route into two. This value is true by default. Optional.

INVALID_REQUEST

The DirectionsRequest provided was invalid.

MAX_WAYPOINTS_EXCEEDED

Too many DirectionsWaypoints were provided in the DirectionsRequest. The total allowed waypoints is 8, plus the origin and destination. Maps API for Business customers are allowed 23 waypoints, plus the origin, and destination.

NOT_FOUND

At least one of the origin, destination, or waypoints could not be geocoded.

OK

The response contains a valid DirectionsResult.

OVER_QUERY_LIMIT

The webpage has gone over the requests limit in too short a period of time.

REQUEST_DENIED

The webpage is not allowed to use the directions service.

UNKNOWN_ERROR

A directions request could not be processed due to a server error. The request may succeed if you try again.

ZERO_RESULTS

No route could be found between the origin and destination.

routes

Array.<DirectionsRoute>

An array of DirectionsRoutes, each of which contains information about the legs and steps of which it is composed. There will only be one route unless the DirectionsRequest was made withprovideRouteAlternatives set to true.

bounds

LatLngBounds

The bounds for this route.

copyrights

string

Copyrights text to be displayed for this route.

legs

Array.<DirectionsLeg>

An array of DirectionsLegs, each of which contains information about the steps of which it is composed. There will be one leg for each waypoint or destination specified. So a route with no waypoints will contain one DirectionsLeg and a route with one waypoint will contain two.

overview_path

Array.<LatLng>

An array of LatLngs representing the entire course of this route. The path is simplified in order to make it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs).

warnings

Array.<string>

Warnings to be displayed when showing these directions.

waypoint_order

Array.<number>

If optimizeWaypoints was set to true, this field will contain the re-ordered permutation of the input waypoints. For example, if the input was:
  Origin: Los Angeles
  Waypoints: Dallas, Bangor, Phoenix
  Destination: New York
and the optimized output was ordered as follows:
  Origin: Los Angeles
  Waypoints: Phoenix, Dallas, Bangor
  Destination: New York
then this field will be an Array containing the values [2, 0, 1]. Note that the numbering of waypoints is zero-based.
If any of the input waypoints has stopover set to false, this field will be empty, since route optimization is not available for such queries.

arrival_time

Time

An estimated arrival time for this leg. Only applicable for TRANSIT requests.

departure_time

Time

An estimated departure time for this leg. Only applicable for TRANSIT requests.

distance

Distance

The total distance covered by this leg. This property may be undefined as the distance may be unknown.

duration

Duration

The total duration of this leg. This property may be undefined as the duration may be unknown.

duration_in_traffic

Duration

The total duration of this leg, taking into account current traffic conditions. This property may be undefined as the duration may be unknown. Only available to Maps API for Business customers when durationInTraffic is set to true when making the request.

end_address

string

The address of the destination of this leg.

end_location

LatLng

The DirectionsService calculates directions between locations by using the nearest transportation option (usually a road) at the start and end locations. end_location indicates the actual geocoded destination, which may be different than the end_location of the last step if, for example, the road is not near the destination of this leg.

start_address

string

The address of the origin of this leg.

start_location

LatLng

The DirectionsService calculates directions between locations by using the nearest transportation option (usually a road) at the start and end locations. start_location indicates the actual geocoded origin, which may be different than the start_location of the first step if, for example, the road is not near the origin of this leg.

steps

Array.<DirectionsStep>

An array of DirectionsSteps, each of which contains information about the individual steps in this leg.

via_waypoints

Array.<LatLng>

An array of waypoints along this leg that were not specified in the original request, either as a result of a user dragging the polyline or selecting an alternate route.

distance

Distance

The distance covered by this step. This property may be undefined as the distance may be unknown.

duration

Duration

The typical time required to perform this step in seconds and in text form. This property may be undefined as the duration may be unknown.

end_location

LatLng

The ending location of this step.

instructions

string

Instructions for this step.

path

Array.<LatLng>

A sequence of LatLngs describing the course of this step.

start_location

LatLng

The starting location of this step.

steps

DirectionsStep

Sub-steps of this step. Specified for non-transit sections of transit routes.

transit

TransitDetails

Transit-specific details about this step. This property will be undefined unless the travel mode of this step is TRANSIT.

travel_mode

TravelMode

The mode of travel used in this step.

text

string

A string representation of the distance value, using the UnitSystem specified in the request.

value

number

The distance in meters.

text

string

A string representation of the duration value.

value

number

The duration in seconds.

text

string

A string representing the time's value. The time is displayed in the time zone of the transit stop.

time_zone

string

The time zone in which this stop lies. The value is the name of the time zone as defined in the IANA Time Zone Database, e.g. "America/New_York".

value

Date

The time of this departure or arrival, specified as a JavaScript Date object.

arrival_stop

TransitStop

The arrival stop of this transit step.

arrival_time

Time

The arrival time of this step, specified as a Time object.

departure_stop

TransitStop

The departure stop of this transit step.

departure_time

Time

The departure time of this step, specified as a Time object.

headsign

string

The direction in which to travel on this line, as it is marked on the vehicle or at the departure stop.

headway

number

The expected number of seconds between equivalent vehicles at this stop.

line

TransitLine

Details about the transit line used in this step.

num_stops

number

The number of stops on this step. Includes the arrival stop, but not the departure stop.

location

LatLng

The location of this stop.

name

string

The name of this transit stop.

agencies

Array.<TransitAgency>

The transit agency that operates this transit line.

color

string

The color commonly used in signage for this transit line, represented as a hex string.

icon

string

The URL for an icon associated with this line.

name

string

The full name of this transit line, e.g. "8 Avenue Local".

short_name

string

The short name of this transit line, e.g. "E".

text_color

string

The text color commonly used in signage for this transit line, represented as a hex string.

url

string

The agency's URL which is specific to this transit line.

vehicle

TransitVehicle

The type of vehicle used, e.g. train or bus.

name

string

The name of this transit agency.

phone

string

The transit agency's phone number.

url

string

The transit agency's URL.

icon

string

A URL for an icon that corresponds to the type of vehicle used on this line.

local_icon

string

A URL for an icon that corresponds to the type of vehicle used in this region instead of the more general icon.

name

string

A name for this type of TransitVehicle, e.g. "Train" or "Bus".

type

VehicleType

The type of vehicle used, e.g. train, bus, or ferry.

BUS

Bus.

CABLE_CAR

A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT.

COMMUTER_TRAIN

Commuter rail.

FERRY

Ferry.

FUNICULAR

A vehicle that is pulled up a steep incline by a cable.

GONDOLA_LIFT

An aerial cable car.

HEAVY_RAIL

Heavy rail.

HIGH_SPEED_TRAIN

High speed train.

INTERCITY_BUS

Intercity bus.

METRO_RAIL

Light rail.

MONORAIL

Monorail.

OTHER

Other vehicles.

RAIL

Rail.

SHARE_TAXI

Share taxi is a sort of bus transport with ability to drop off and pick up passengers anywhere on its route. Generally share taxi uses minibus vehicles.

SUBWAY

Underground light rail.

TRAM

Above ground light rail.

TROLLEYBUS

Trolleybus.

ElevationService()

Creates a new instance of a ElevationService that sends elevation queries to Google servers.

getElevationAlongPath(request:PathElevationRequest, callback:function(Array.<ElevationResult>, ElevationStatus))

None

Makes an elevation request along a path, where the elevation data are returned as distance-based samples along that path.

getElevationForLocations(request:LocationElevationRequest, callback:function(Array.<ElevationResult>, ElevationStatus))

None

Makes an elevation request for a list of discrete locations.

locations

Array.<LatLng>

The discrete locations for which to retrieve elevations.

path

Array.<LatLng>

The path along which to collect elevation values.

samples

number

Required. The number of equidistant points along the given path for which to retrieve elevation data, including the endpoints. The number of samples must be a value between 2 and 512 inclusive.

elevation

number

The elevation of this point on Earth, in meters above sea level.

location

LatLng

The location of this elevation result.

resolution

number

The distance, in meters, between sample points from which the elevation was interpolated. This property will be missing if the resolution is not known. Note that elevation data becomes more coarse (larger resolution values) when multiple points are passed. To obtain the most accurate elevation value for a point, it should be queried independently.

INVALID_REQUEST

This request was invalid.

OK

The request did not encounter any errors.

OVER_QUERY_LIMIT

The webpage has gone over the requests limit in too short a period of time.

REQUEST_DENIED

The webpage is not allowed to use the elevation service for some reason.

UNKNOWN_ERROR

A geocoding, directions or elevation request could not be successfully processed, yet the exact reason for the failure is not known.

MaxZoomService()

Creates a new instance of a MaxZoomService that can be used to send queries about the maximum zoom level available for satellite imagery.

getMaxZoomAtLatLng(latlng:LatLng|LatLngLiteral, callback:function(MaxZoomResult))

None

Returns the maximum zoom level available at a particular LatLng for the Satellite map type. As this request is asynchronous, you must pass a callbackfunction which will be executed upon completion of the request, being passed a MaxZoomResult.

status

MaxZoomStatus

Status of the request.

zoom

number

The maximum zoom level found at the given LatLng.

ERROR

There was a problem contacting the Google servers.

OK

The response contains a valid MaxZoomResult.

DistanceMatrixService()

Creates a new instance of a DistanceMatrixService that sends distance matrix queries to Google servers.

getDistanceMatrix(request:DistanceMatrixRequest, callback:function(DistanceMatrixResponse,DistanceMatrixStatus))

None

Issues a distance matrix request.

avoidFerries

boolean

If true, instructs the Distance Matrix service to avoid ferries where possible. Optional.

avoidHighways

boolean

If true, instructs the Distance Matrix service to avoid highways where possible. Optional.

avoidTolls

boolean

If true, instructs the Distance Matrix service to avoid toll roads where possible. Optional.

destinations

Array.<LatLng>|Array.<string>

An array containing destination address strings and/or LatLngs, to which to calculate distance and time. Required.

durationInTraffic

boolean

Whether or not we should provide trip durations based on current traffic conditions. Only available to Maps API for Business customers.

origins

Array.<LatLng>|Array.<string>

An array containing origin address strings and/or LatLngs, from which to calculate distance and time. Required.

region

string

Region code used as a bias for geocoding requests. Optional.

travelMode

TravelMode

Type of routing requested. Required.

unitSystem

UnitSystem

Preferred unit system to use when displaying distance. Optional; defaults to metric.

destinationAddresses

Array.<string>

The formatted destination addresses.

originAddresses

Array.<string>

The formatted origin addresses.

rows

Array.<DistanceMatrixResponseRow>

The rows of the matrix, corresponding to the origin addresses.

elements

Array.<DistanceMatrixResponseElement>

The row's elements, corresponding to the destination addresses.

distance

Distance

The distance for this origin-destination pairing. This property may be undefined as the distance may be unknown.

duration

Duration

The duration for this origin-destination pairing. This property may be undefined as the duration may be unknown.

status

DistanceMatrixElementStatus

The status of this particular origin-destination pairing.

INVALID_REQUEST

The provided request was invalid.

MAX_DIMENSIONS_EXCEEDED

The request contains more than 25 origins, or more than 25 destinations.

MAX_ELEMENTS_EXCEEDED

The product of origins and destinations exceeds the per-query limit.

OK

The response contains a valid result.

OVER_QUERY_LIMIT

Too many elements have been requested within the allowed time period. The request should succeed if you try again after a reasonable amount of time.

REQUEST_DENIED

The service denied use of the Distance Matrix service by your web page.

UNKNOWN_ERROR

A Distance Matrix request could not be processed due to a server error. The request may succeed if you try again.

NOT_FOUND

The origin and/or destination of this pairing could not be geocoded.

OK

The response contains a valid result.

ZERO_RESULTS

No route could be found between the origin and destination.

getTile(tileCoord:Point, zoom:number, ownerDocument:Document)

Node

Returns a tile for the given tile coordinate (x, y) and zoom level. This tile will be appended to the given ownerDocument. Not available for base map types.

releaseTile(tile:Node)

None

Releases the given tile, performing any necessary cleanup. The provided tile will have already been removed from the document. Optional.

alt

string

Alt text to display when this MapType's button is hovered over in the MapTypeControl. Optional.

maxZoom

number

The maximum zoom level for the map when displaying this MapType. Required for base MapTypes, ignored for overlay MapTypes.

minZoom

number

The minimum zoom level for the map when displaying this MapType. Optional; defaults to 0.

name

string

Name to display in the MapTypeControl. Optional.

projection

Projection

The Projection used to render this MapType. Optional; defaults to Mercator.

radius

number

Radius of the planet for the map, in meters. Optional; defaults to Earth's equatorial radius of 6378137 meters.

tileSize

Size

The dimensions of each tile. Required.

MapTypeRegistry()

The MapTypeRegistry holds the collection of custom map types available to the map for its use. The API consults this registry when providing the list of avaiable map types within controls, for example.

set(id:string, mapType:MapType|undefined)

None

Sets the registry to associate the passed string identifier with the passed MapType.

fromLatLngToPoint(latLng:LatLng, point?:Point)

Point

Translates from the LatLng cylinder to the Point plane. This interface specifies a function which implements translation from given LatLng values to world coordinates on the map projection. The Maps API calls this method when it needs to plot locations on screen.Projection objects must implement this method.

fromPointToLatLng(pixel:Point, nowrap?:boolean)

LatLng

This interface specifies a function which implements translation from world coordinates on a map projection to LatLng values. The Maps API calls this method when it needs to translate actions on screen to positions on the map. Projection objects must implement this method.