Skip to content

Latest commit

 

History

History
368 lines (367 loc) · 24 KB

File metadata and controls

368 lines (367 loc) · 24 KB

Map class

google.maps.Map class

This class extends MVCObject.

Constructor
Map
Map(mapDiv[, opts])
Parameters: 
Creates a new map inside of the given HTML container, which is typically a DIV element.
Methods
fitBounds
fitBounds(bounds[, padding])
Parameters: 
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: 
  • xnumber
  • ynumber
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: 
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: 
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: 
Return Value:  None
setClickableIcons
setClickableIcons(value)
Parameters: 
  • valueboolean
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: 
  • headingnumber
Return Value:  None
Sets the compass heading for aerial imagery measured in degrees from cardinal direction North.
setMapTypeId
setMapTypeId(mapTypeId)
Parameters: 
Return Value:  None
setOptions
setOptions(options)
Parameters: 
Return Value:  None
setStreetView
setStreetView(panorama)
Parameters: 
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: 
  • tiltnumber
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: 
  • zoomnumber
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
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: 
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: 
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: 
This event is fired whenever the user's mouse moves over the map container.
mouseout
function(event)
Arguments: 
This event is fired when the user's mouse exits the map container.
mouseover
function(event)
Arguments: 
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: 
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.
<script src="replace_links.js"></script>