Skip to content

Latest commit

 

History

History
103 lines (55 loc) · 3.01 KB

LatLng.md

File metadata and controls

103 lines (55 loc) · 3.01 KB

See html formatted version

LatLng class

google.maps.LatLng class

A LatLng is a point in geographical coordinates: latitude and longitude.

  • Latitude ranges between -90 and 90 degrees, inclusive. Values above or below this range will be clamped to the range [-90, 90]. This means that if the value specified is less than -90, it will be set to -90. And if the value is greater than 90, it will be set to 90.
  • Longitude ranges between -180 and 180 degrees, inclusive. Values above or below this range will be wrapped so that they fall within the range. For example, a value of -190 will be converted to 170. A value of 190 will be converted to -170. This reflects the fact that longitudes wrap around the globe.

Although the default map projection associates longitude with the x-coordinate of the map, and latitude with the y-coordinate, the latitude coordinate is always written first, followed by the longitude.
Notice that you cannot modify the coordinates of a LatLng. If you want to compute another point, you have to create a new one.

Most methods that accept LatLng objects also accept a LatLngLiteral object, so that the following are equivalent:

map.setCenter(new google.maps.LatLng(-34, 151));
map.setCenter({lat: -34, lng: 151});

The constructor also accepts literal objects, and converts them to instances of LatLng:

myLatLng = new google.maps.LatLng({lat: -34, lng: 151});

Constructor

undefined

LatLng(lat, lng[, noWrap])

Parameters: 

  • lat:  number
  • lng:  number
  • noWrap:  boolean optional

Creates a LatLng object representing a geographic point. Latitude is specified in degrees within the range [-90, 90]. Longitude is specified in degrees within the range [-180, 180]. Set noWrap to true to enable values outside of this range. Note the ordering of latitude and longitude.

Methods

undefined

equals(other)

Parameters: 

Return Value:  boolean

Comparison function.

undefined

lat()

Parameters:  None

Return Value:  number

Returns the latitude in degrees.

undefined

lng()

Parameters:  None

Return Value:  number

Returns the longitude in degrees.

undefined

toJSON()

Parameters:  None

Return Value:  LatLngLiteral

Converts to JSON representation. This function is intended to be used via JSON.stringify.

undefined

toString()

Parameters:  None

Return Value:  string

Converts to string representation.

undefined

toUrlValue([precision])

Parameters: 

  • precision:  number optional

Return Value:  string

Returns a string of the form "lat,lng" for this LatLng. We round the lat/lng values to 6 decimal places by default.