Maps

Map class

google.maps.Map class

This class extends MVCObject.

Constructor
`Map`	`Map(mapDiv[, opts])` Parameters: `mapDiv`: `Element` `opts` (optional): `MapOptions` Creates a new map inside of the given HTML container, which is typically a `DIV` element.

Methods
`fitBounds`	`fitBounds(bounds[, padding])` Parameters: `bounds`: `LatLngBounds\|LatLngBoundsLiteral` `padding` (optional): `number\|Padding` Return Value: None Sets the viewport to contain the given bounds. Note: When the map is set to `display: none`, the `fitBounds` function reads the map's size as 0x0, and therefore does not do anything. To change the viewport while the map is hidden, set the map to `visibility: hidden`, thereby ensuring the map div has an actual size.
`getBounds`	`getBounds()` Parameters: None Return Value: `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`	`getCenter()` Parameters: None Return Value: `LatLng` Returns the position displayed at the center of the map. Note that this `LatLng` object is not wrapped. See `LatLng` for more information.
`getClickableIcons`	`getClickableIcons()` Parameters: None Return Value: `boolean` Returns the clickability of the map icons. A map icon represents a point of interest, also known as a POI. If the returned value is true, then the icons are clickable on the map.
`getDiv`	`getDiv()` Parameters: None Return Value: `Element`
`getHeading`	`getHeading()` Parameters: None Return Value: `number` Returns the compass heading of aerial imagery. The heading value is measured in degrees (clockwise) from cardinal direction North.
`getMapTypeId`	`getMapTypeId()` Parameters: None Return Value: `MapTypeId\|string`
`getProjection`	`getProjection()` Parameters: None Return Value: `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 to `projection_changed` and check its value to ensure it is not null.
`getStreetView`	`getStreetView()` Parameters: None Return Value: `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`	`getTilt()` Parameters: None Return Value: `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 by `setTilt`. See `setTilt` for details.
`getZoom`	`getZoom()` Parameters: None Return Value: `number`
`panBy`	`panBy(x, y)` Parameters: `x`: `number` `y`: `number` Return Value: 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`	`panTo(latLng)` Parameters: `latLng`: `LatLng\|LatLngLiteral` Return Value: 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`	`panToBounds(latLngBounds[, padding])` Parameters: `latLngBounds`: `LatLngBounds\|LatLngBoundsLiteral` `padding` (optional): `number\|Padding` Return Value: None Pans the map by the minimum amount necessary to contain the given `LatLngBounds`. It makes no guarantee where on the map the bounds will be, except that the map will be panned to show as much of the bounds as possible inside `{currentMapSizeInPx} - {padding}`.
`setCenter`	`setCenter(latlng)` Parameters: `latlng`: `LatLng\|LatLngLiteral` Return Value: None
`setClickableIcons`	`setClickableIcons(value)` Parameters: `value`: `boolean` Return Value: None Controls whether the map icons are clickable or not. A map icon represents a point of interest, also known as a POI. To disable the clickability of map icons, pass a value of `false` to this method.
`setHeading`	`setHeading(heading)` Parameters: `heading`: `number` Return Value: None Sets the compass heading for aerial imagery measured in degrees from cardinal direction North.
`setMapTypeId`	`setMapTypeId(mapTypeId)` Parameters: `mapTypeId`: `MapTypeId\|string` Return Value: None
`setOptions`	`setOptions(options)` Parameters: `options`: `MapOptions` Return Value: None
`setStreetView`	`setStreetView(panorama)` Parameters: `panorama`: `StreetViewPanorama` Return Value: 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`	`setTilt(tilt)` Parameters: `tilt`: `number` Return Value: 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`	`setZoom(zoom)` Parameters: `zoom`: `number` Return Value: None

Properties
`controls`	Type: `Array<MVCArray<Node>>` Additional controls to attach to the map. To add a control to the map, add the control's `<div>` to the `MVCArray` corresponding to the `ControlPosition` where it should be rendered.
`data`	Type: `Data` An instance of `Data`, bound to the map. Add features to this `Data` object to conveniently display them on this map.
`mapTypes`	Type: `MapTypeRegistry` A registry of `MapType` instances by string ID.
`overlayMapTypes`	Type: `MVCArray<MapType>` Additional map types to overlay. Overlay map types will display on top of the base map they are attached to, in the order in which they appear in the `overlayMapTypes` array (overlays with higher index values are displayed in front of overlays with lower index values).

Events
`bounds_changed`	`function()` Arguments: None This event is fired when the viewport bounds have changed.
`center_changed`	`function()` Arguments: None This event is fired when the map center property changes.
`click`	`function(event)` Arguments: `event`: `MouseEvent\|IconMouseEvent` This event is fired when the user clicks on the map. An ApiMouseEvent with properties for the clicked location is returned unless a place icon was clicked, in which case an IconMouseEvent with a placeid is returned. IconMouseEvent and ApiMouseEvent are identical, except that IconMouseEvent has the placeid field. The event can always be treated as an ApiMouseEvent when the placeid is not important. The click event is not fired if a marker or infowindow was clicked.
`dblclick`	`function(event)` Arguments: `event`: `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`	`function()` Arguments: None This event is repeatedly fired while the user drags the map.
`dragend`	`function()` Arguments: None This event is fired when the user stops dragging the map.
`dragstart`	`function()` Arguments: None This event is fired when the user starts dragging the map.
`heading_changed`	`function()` Arguments: None This event is fired when the map heading property changes.
`idle`	`function()` Arguments: None This event is fired when the map becomes idle after panning or zooming.
`maptypeid_changed`	`function()` Arguments: None This event is fired when the mapTypeId property changes.
`mousemove`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired whenever the user's mouse moves over the map container.
`mouseout`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the user's mouse exits the map container.
`mouseover`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the user's mouse enters the map container.
`projection_changed`	`function()` Arguments: None This event is fired when the projection has changed.
`rightclick`	`function(event)` Arguments: `event`: `MouseEvent` This event is fired when the DOM contextmenu event is fired on the map container.
`tilesloaded`	`function()` Arguments: None This event is fired when the visible tiles have finished loading.
`tilt_changed`	`function()` Arguments: None This event is fired when the map tilt property changes.
`zoom_changed`	`function()` Arguments: None This event is fired when the map zoom property changes.

MapOptions interface

google.maps.MapOptions interface

MapOptions object used to define the properties that can be set on a Map.

Properties
`backgroundColor`	Type: `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`	Type: `LatLng\|LatLngLiteral` The initial Map center. Required.
`clickableIcons`	Type: `boolean` When `false`, map icons are not clickable. A map icon represents a point of interest, also known as a POI. By default map icons are clickable.
`disableDefaultUI`	Type: `boolean` Enables/disables all default UI. May be overridden individually.
`disableDoubleClickZoom`	Type: `boolean` Enables/disables zoom and center on double click. Enabled by default. Note: This property is not recommended. To disable zooming on double click, you can use the `gestureHandling` property, and set it to `"none"`.
`draggable`	Type: `boolean` If false, prevents the map from being dragged. Dragging is enabled by default. Note: This property is deprecated. To disable dragging on the map, you can use the `gestureHandling` property, and set it to `"none"`.
`draggableCursor`	Type: `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`	Type: `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;'`.
`fullscreenControl`	Type: `boolean` The enabled/disabled state of the Fullscreen control.
`fullscreenControlOptions`	Type: `FullscreenControlOptions` The display options for the Fullscreen control.
`gestureHandling`	Type: `string` This setting controls how the API handles gestures on the map. Allowed values: `"cooperative"`: Scroll events and one-finger touch gestures scroll the page, and do not zoom or pan the map. Two-finger touch gestures pan and zoom the map. Scroll events with a ctrl key or ⌘ key pressed zoom the map. In this mode the map cooperates with the page. `"greedy"`: All touch gestures and scroll events pan or zoom the map. `"none"`: The map cannot be panned or zoomed by user gestures. `"auto"`: (default) Gesture handling is either cooperative or greedy, depending on whether the page is scrollable or in an iframe.
`heading`	Type: `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`	Type: `boolean` If false, prevents the map from being controlled by the keyboard. Keyboard shortcuts are enabled by default.
`mapTypeControl`	Type: `boolean` The initial enabled/disabled state of the Map type control.
`mapTypeControlOptions`	Type: `MapTypeControlOptions` The initial display options for the Map type control.
`mapTypeId`	Type: `MapTypeId\|string` The initial Map mapTypeId. Defaults to `ROADMAP`.
`maxZoom`	Type: `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. Valid values: Integers between zero, and up to the supported maximum zoom level.
`minZoom`	Type: `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. Valid values: Integers between zero, and up to the supported maximum zoom level.
`noClear`	Type: `boolean` If true, do not clear the contents of the Map div.
`panControl`	Type: `boolean` The enabled/disabled state of the Pan control. Note: The Pan control is not available in the new set of controls introduced in v3.22 of the Google Maps JavaScript API. While using v3.22 and v3.23, you can choose to use the earlier set of controls rather than the new controls, thus making the Pan control available as part of the old control set. See What's New in the v3.22 Map Controls.
`panControlOptions`	Type: `PanControlOptions` The display options for the Pan control. Note: The Pan control is not available in the new set of controls introduced in v3.22 of the Google Maps JavaScript API. While using v3.22 and v3.23, you can choose to use the earlier set of controls rather than the new controls, thus making the Pan control available as part of the old control set. See What's New in the v3.22 Map Controls.
`rotateControl`	Type: `boolean` The enabled/disabled state of the Rotate control.
`rotateControlOptions`	Type: `RotateControlOptions` The display options for the Rotate control.
`scaleControl`	Type: `boolean` The initial enabled/disabled state of the Scale control.
`scaleControlOptions`	Type: `ScaleControlOptions` The initial display options for the Scale control.
`scrollwheel`	Type: `boolean` If false, disables zooming on the map using a mouse scroll wheel. The scrollwheel is enabled by default. Note: This property is not recommended. To disable zooming using scrollwheel, you can use the `gestureHandling` property, and set it to either `"cooperative"` or `"none"`.
`streetView`	Type: `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`	Type: `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`	Type: `StreetViewControlOptions` The initial display options for the Street View Pegman control.
`styles`	Type: `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`	Type: `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 for `satellite` 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`	Type: `number` The initial Map zoom level. Required. Valid values: Integers between zero, and up to the supported maximum zoom level.
`zoomControl`	Type: `boolean` The enabled/disabled state of the Zoom control.
`zoomControlOptions`	Type: `ZoomControlOptions` The display options for the Zoom control.

The MapTypeStyle is a collection of selectors and stylers that define how the map should be styled. Selectors specify the map features and/or elements that should be affected, and stylers specify how those features and elements should be modified. For details, see the style reference.

Properties
`elementType`	Type: `string` The element to which a styler should be applied. An element is a visual aspect of a feature on the map. Example: a label, an icon, the stroke or fill applied to the geometry, and more. Optional. If `elementType` is not specified, the value is assumed to be `'all'`. For details of usage and allowed values, see the style reference.
`featureType`	Type: `string` The feature, or group of features, to which a styler should be applied. Optional. If `featureType` is not specified, the value is assumed to be `'all'`. For details of usage and allowed values, see the style reference.
`stylers`	Type: `Array<Object>` The style rules to apply to the selected map features and elements. The rules are applied in the order that you specify in this array. For guidelines on usage and allowed values, see the style reference.

MouseEvent interface

google.maps.MouseEvent interface

This object is returned from various mouse events on the map and overlays, and contains all the fields shown below.

Methods
`stop`	`stop()` Parameters: None Return Value: None Prevents this event from propagating further.

Properties
`latLng`	Type: `LatLng` The latitude/longitude that was below the cursor when the event occurred.

IconMouseEvent interface

google.maps.IconMouseEvent interface

This object is sent in an event when a user clicks on an icon on the map. The place ID of this place is stored in the placeId member. To prevent the default info window from showing up, call the stop() method on this event to prevent it being propagated. Learn more about place IDs in the Places API developer guide.

This interface extends MouseEvent.

Properties
`placeId`	Type: `string` The place ID of the place that was clicked. This place ID can be used to query more information about the feature that was clicked. Learn more about place IDs in the Places API developer guide.

MapTypeId constants

google.maps.MapTypeId constants

Identifiers for common MapTypes. Specify these by value, or by using the constant's name. For example, 'satellite' or google.maps.MapTypeId.SATELLITE.

Constants
`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.

MapTypeRegistry class

google.maps.MapTypeRegistry class

A registry for MapType instances, keyed by MapType id.

This class extends MVCObject.

Constructor
`MapTypeRegistry`	`MapTypeRegistry()` Parameters: None 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.

Methods
`set`	`set(id, mapType)` Parameters: `id`: `string` `mapType`: `MapType\|` Return Value:* None Sets the registry to associate the passed string identifier with the passed MapType.

TrafficLayer class

google.maps.TrafficLayer class

A traffic layer.

This class extends MVCObject.

Constructor
`TrafficLayer`	`TrafficLayer([opts])` Parameters: `opts` (optional): `TrafficLayerOptions` A layer that displays current road traffic.

Methods
`getMap`	`getMap()` Parameters: None Return Value: `Map` Returns the map on which this layer is displayed.
`setMap`	`setMap(map)` Parameters: `map`: `Map` Return Value: None Renders the layer on the specified map. If map is set to null, the layer will be removed.
`setOptions`	`setOptions(options)` Parameters: `options`: `TrafficLayerOptions` Return Value: None

TrafficLayerOptions interface

google.maps.TrafficLayerOptions interface

TrafficLayerOptions object used to define the properties that can be set on a TrafficLayer.

Properties
`autoRefresh`	Type: `boolean` Whether the traffic layer refreshes with updated information automatically. This is true by default.
`map`	Type: `Map` Map on which to display the traffic layer.

TransitLayer class

google.maps.TransitLayer class

A transit layer.

This class extends MVCObject.

Constructor
`TransitLayer`	`TransitLayer()` Parameters: None A layer that displays transit lines.

Methods
`getMap`	`getMap()` Parameters: None Return Value: `Map` Returns the map on which this layer is displayed.
`setMap`	`setMap(map)` Parameters: `map`: `Map` Return Value: None Renders the layer on the specified map. If map is set to null, the layer will be removed.

BicyclingLayer class

google.maps.BicyclingLayer class

A layer showing bike lanes and paths.

This class extends MVCObject.

Constructor
`BicyclingLayer`	`BicyclingLayer()` Parameters: None A layer that displays bike lanes and paths and demotes large roads.

Methods
`getMap`	`getMap()` Parameters: None Return Value: `Map` Returns the map on which this layer is displayed.
`setMap`	`setMap(map)` Parameters: `map`: `Map` Return Value: None Renders the layer on the specified map. If map is set to null, the layer will be removed.

Map class

MapOptions interface

MapTypeStyle interface

MouseEvent interface

IconMouseEvent interface

MapTypeId constants

MapTypeRegistry class

TrafficLayer class

TrafficLayerOptions interface

TransitLayer class

BicyclingLayer class

Send feedback about...