Geometry Library

encoding namespace

google.maps.geometry.encoding namespace

Utilities for polyline encoding and decoding.

Library

geometry

Static Methods
`decodePath`	`decodePath(encodedPath)` Parameters: `encodedPath`: `string` Return Value: `Array<LatLng>` Decodes an encoded path string into a sequence of LatLngs.
`encodePath`	`encodePath(path)` Parameters: `path`: `Array<LatLng>\|MVCArray<LatLng>` Return Value: `string` Encodes a sequence of LatLngs into an encoded path string.

spherical namespace

google.maps.geometry.spherical namespace

Utility functions for computing geodesic angles, distances and areas. The default radius is Earth's radius of 6378137 meters.

Library

geometry

Static Methods
`computeArea`	`computeArea(path[, radius])` Parameters: `path`: `Array<LatLng>\|MVCArray<LatLng>` `radius`: `number optional` Return Value: `number` Returns the area of a closed path. The computed area uses the same units as the radius. The radius defaults to the Earth's radius in meters, in which case the area is in square meters.
`computeDistanceBetween`	`computeDistanceBetween(from, to[, radius])` Parameters: `from`: `LatLng` `to`: `LatLng` `radius`: `number optional` Return Value: `number` Returns the distance, in meters, between two LatLngs. You can optionally specify a custom radius. The radius defaults to the radius of the Earth.
`computeHeading`	`computeHeading(from, to)` Parameters: `from`: `LatLng` `to`: `LatLng` Return Value: `number` Returns the heading from one LatLng to another LatLng. Headings are expressed in degrees clockwise from North within the range [-180,180).
`computeLength`	`computeLength(path[, radius])` Parameters: `path`: `Array<LatLng>\|MVCArray<LatLng>` `radius`: `number optional` Return Value: `number` Returns the length of the given path.
`computeOffset`	`computeOffset(from, distance, heading[, radius])` Parameters: `from`: `LatLng` `distance`: `number` `heading`: `number` `radius`: `number optional` Return Value: `LatLng` Returns the LatLng resulting from moving a distance from an origin in the specified heading (expressed in degrees clockwise from north).
`computeOffsetOrigin`	`computeOffsetOrigin(to, distance, heading[, radius])` Parameters: `to`: `LatLng` `distance`: `number` `heading`: `number` `radius`: `number optional` Return Value: `LatLng` Returns the location of origin when provided with a LatLng destination, meters travelled and original heading. Headings are expressed in degrees clockwise from North. This function returns null when no solution is available.
`computeSignedArea`	`computeSignedArea(loop[, radius])` Parameters: `loop`: `Array<LatLng>\|MVCArray<LatLng>` `radius`: `number optional` Return Value: `number` Returns the signed area of a closed path. The signed area may be used to determine the orientation of the path. The computed area uses the same units as the radius. The radius defaults to the Earth's radius in meters, in which case the area is in square meters.
`interpolate`	`interpolate(from, to, fraction)` Parameters: `from`: `LatLng` `to`: `LatLng` `fraction`: `number` Return Value: `LatLng` Returns the LatLng which lies the given fraction of the way between the origin LatLng and the destination LatLng.

poly namespace

google.maps.geometry.poly namespace

Utility functions for computations involving polygons and polylines.

Library

geometry

Static Methods

Static Methods
`containsLocation`	`containsLocation(point, polygon)` Parameters: `point`: `LatLng` `polygon`: `Polygon` Return Value: `boolean` Computes whether the given point lies inside the specified polygon.
`isLocationOnEdge`	`isLocationOnEdge(point, poly[, tolerance])` Parameters: `point`: `LatLng` `poly`: `Polygon\|Polyline` `tolerance`: `number optional` Return Value: `boolean` Computes whether the given point lies on or near to a polyline, or the edge of a polygon, within a specified tolerance. Returns `true` when the difference between the latitude and longitude of the supplied point, and the closest point on the edge, is less than the tolerance. The tolerance defaults to 10^-9 degrees.

containsLocation

containsLocation(point, polygon)

Parameters:

point: LatLng
polygon: Polygon

Return Value: boolean

Computes whether the given point lies inside the specified polygon.

isLocationOnEdge

isLocationOnEdge(point, poly[, tolerance])

Parameters:

point: LatLng
poly: Polygon|Polyline
tolerance: number optional

Return Value: boolean

Computes whether the given point lies on or near to a polyline, or the edge of a polygon, within a specified tolerance. Returns true when the difference between the latitude and longitude of the supplied point, and the closest point on the edge, is less than the tolerance. The tolerance defaults to 10^-9 degrees.