LatLng class
google.maps.LatLng
class
ALatLng
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.
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 acceptLatLng
objects also accept aLatLngLiteral
object, so that the following are equivalent:
map.setCenter(new google.maps.LatLng(-34, 151));
map.setCenter({lat: -34, lng: 151});
The constructor also acceptsLatLngLiteral
andLatLng
objects. If aLatLng
instance is passed to the constructor, a copy is created.
The possible calls to the constructor are below:
new google.maps.LatLng(-34, 151);
new google.maps.LatLng(-34, 151, true);
new google.maps.LatLng({lat: -34, lng: 151});
new google.maps.LatLng({lat: -34, lng: 151}, true);
new google.maps.LatLng(new google.maps.LatLng(-34, 151));
new google.maps.LatLng(new google.maps.LatLng(-34, 151), true);
Access by callingconst {LatLng} = await google.maps.importLibrary( "core" )
.SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
LatLng |
LatLng(latOrLatLngOrLatLngLiteral[, lngOrNoClampNoWrap, noClampNoWrap]) Parameters:
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). SetnoClampNoWrap totrue to enable values outside of this range. Note the ordering of latitude and longitude. |
Methods | |
---|---|
equals |
equals(other) Parameters:
Return Value:
boolean Comparison function. |
lat |
lat() Parameters:None
Return Value:
number Returns the latitude in degrees. |
lng |
lng() Parameters:None
Return Value:
number Returns the longitude in degrees. |
toJSON |
toJSON() Parameters:None
Return Value:
LatLngLiteral Converts to JSON representation. This function is intended to be used via JSON.stringify . |
toString |
toString() Parameters:None
Return Value:
string Converts to string representation. |
toUrlValue |
toUrlValue([precision]) Parameters:
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. |
LatLngLiteral interface
google.maps.LatLngLiteral
interface
Object literals are accepted in place ofLatLng
objects, as a convenience, in many places. These are converted toLatLng
objects when the Maps API encounters them.
Examples:
map.setCenter({lat: -34, lng: 151});
new google.maps.Marker({position: {lat: -34, lng: 151}, map: map});
LatLng object literals are not supported in the Geometry library.
Properties | |
---|---|
lat |
Type:
number Latitude in degrees. Values 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. |
lng |
Type:
number Longitude in degrees. Values outside the range [-180, 180] 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. |
LatLngBounds class
google.maps.LatLngBounds
class
ALatLngBounds
instance represents a rectangle in geographical coordinates, including one that crosses the 180 degrees longitudinal meridian.
Access by callingconst {LatLngBounds} = await google.maps.importLibrary( "core" )
.SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
LatLngBounds |
LatLngBounds([swOrLatLngBounds, ne]) Parameters:
Constructs a rectangle from the points at its south-west and north-east corners. |
Constants | |
---|---|
MAX_BOUNDS |
LatLngBounds for the max bounds of the Earth. These bounds will encompass the entire globe. |
Methods | |
---|---|
contains |
contains(latLng) Parameters:
Return Value:
boolean Returns true if the given lat/lng is in this bounds. |
equals |
equals(other) Parameters:
Return Value:
boolean Returns true if this bounds approximately equals the given bounds. |
extend |
extend(point) Parameters:
Return Value:
LatLngBounds Extends this bounds to contain the given point. |
getCenter |
getCenter() Parameters:None
Return Value:
LatLng Computes the center of this LatLngBounds |
getNorthEast |
getNorthEast() Parameters:None
Return Value:
LatLng Returns the north-east corner of this bounds. |
getSouthWest |
getSouthWest() Parameters:None
Return Value:
LatLng Returns the south-west corner of this bounds. |
intersects |
intersects(other) Parameters:
Return Value:
boolean Returns true if this bounds shares any points with the other bounds. |
isEmpty |
isEmpty() Parameters:None
Return Value:
boolean Returns if the bounds are empty. |
toJSON |
toJSON() Parameters:None
Return Value:
LatLngBoundsLiteral Converts to JSON representation. This function is intended to be used via JSON.stringify . |
toSpan |
toSpan() Parameters:None
Return Value:
LatLng Converts the given map bounds to a lat/lng span. |
toString |
toString() Parameters:None
Return Value:
string Converts to string. |
toUrlValue |
toUrlValue([precision]) Parameters:
Return Value:
string Returns a string of the form "lat_lo,lng_lo,lat_hi,lng_hi" for this bounds, where "lo" corresponds to the southwest corner of the bounding box, while "hi" corresponds to the northeast corner of that box. |
union |
union(other) Parameters:
Return Value:
LatLngBounds Extends this bounds to contain the union of this and the given bounds. |
LatLngBoundsLiteral interface
google.maps.LatLngBoundsLiteral
interface
Object literals are accepted in place ofLatLngBounds
objects throughout the API. These are automatically converted toLatLngBounds
objects. Allsouth
,west
,north
andeast
must be set, otherwise an exception is thrown.
Properties | |
---|---|
east |
Type:
number East longitude in degrees. Values outside the range [-180, 180] will be wrapped to the range [-180, 180). 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. |
north |
Type:
number North latitude in degrees. Values 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. |
south |
Type:
number South latitude in degrees. Values 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. |
west |
Type:
number West longitude in degrees. Values outside the range [-180, 180] will be wrapped to the range [-180, 180). 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. |
LatLngAltitude class
google.maps.LatLngAltitude
class
ALatLngAltitude
is a 3D point in geographical coordinates: latitude, longitude, and altitude.
- 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.
- Altitude is measured in meters. Positive values denote heights above ground level, and negative values denote heights underneath the ground surface.
This class implements
LatLngAltitudeLiteral
.
This class implements
LatLngLiteral
.
Access by callingconst {LatLngAltitude} = await google.maps.importLibrary( "core" )
.SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
LatLngAltitude |
LatLngAltitude(value[, noClampNoWrap]) Parameters:
|
Properties | |
---|---|
altitude |
Type:
number Returns the altitude. |
lat |
Type:
number Returns the latitude. |
lng |
Type:
number Returns the longitude. |
Methods | |
---|---|
equals |
equals(other) Parameters:
Return Value:
boolean Whether the two objects are equal.Comparison function. |
toJSON |
toJSON() Parameters:None
Return Value:
LatLngAltitudeLiteral A JSON representation of this object. |
LatLngAltitudeLiteral interface
google.maps.LatLngAltitudeLiteral
interface
Object literals are accepted in place ofLatLngAltitude
objects, as a convenience, in many places. These are converted toLatLngAltitude
objects when the Maps API encounters them.
This interface extends
LatLngLiteral
.
Properties | |
---|---|
altitude |
Type:
number Default:
0 Distance (in meters) above the ground surface. Negative value means underneath the ground surface. |
lat |
Type:
number Latitude in degrees. Values 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. |
lng |
Type:
number Longitude in degrees. Values outside the range [-180, 180] 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. |
Point class
google.maps.Point
class
Access by callingconst {Point} = await google.maps.importLibrary( "core" )
.SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Point |
Point(x, y) Parameters:
A point on a two-dimensional plane. |
Properties | |
---|---|
x |
Type:
number The X coordinate |
y |
Type:
number The Y coordinate |
Methods | |
---|---|
equals |
equals(other) Parameters:
Return Value:
boolean Compares two Points |
toString |
toString() Parameters:None
Return Value:
string Returns a string representation of this Point. |
Size class
google.maps.Size
class
Access by callingconst {Size} = await google.maps.importLibrary( "core" )
.SeeLibraries in the Maps JavaScript API.
Constructor | |
---|---|
Size |
Size(width, height[, widthUnit, heightUnit]) Parameters:
Two-dimensional size, where width is the distance on the x-axis, and height is the distance on the y-axis. |
Properties | |
---|---|
height |
Type:
number The height along the y-axis, in pixels. |
width |
Type:
number The width along the x-axis, in pixels. |
Methods | |
---|---|
equals |
equals(other) Parameters:
Return Value:
boolean Compares two Sizes. |
toString |
toString() Parameters:None
Return Value:
string Returns a string representation of this Size. |
Padding interface
google.maps.Padding
interface
Properties | |
---|---|
bottomoptional |
Type:
numberoptional Padding for the bottom, in pixels. |
leftoptional |
Type:
numberoptional Padding for the left, in pixels. |
rightoptional |
Type:
numberoptional Padding for the right, in pixels. |
topoptional |
Type:
numberoptional Padding for the top, in pixels. |
CircleLiteral interface
google.maps.CircleLiteral
interface
Object literal which represents a circle.
This interface extends
CircleOptions
.
Properties | |
---|---|
center |
Type:
LatLng|LatLngLiteral The center of the Circle. |
radius |
Type:
number The radius in meters on the Earth's surface. |
Inherited:
clickable ,
draggable ,
editable ,
fillColor ,
fillOpacity ,
map ,
strokeColor ,
strokeOpacity ,
strokePosition ,
strokeWeight ,
visible ,
zIndex
|