Class MapUtil

This is a utility class that performs various calculations related to maps. All methods are static so an instance of this class should not be created.

Since

2.0.0

Hierarchy

MapUtil

Index

Constructors

Methods

angleAndDirectionBetweenLocations angleAndDirectionBetweenWaypoints averageOfCoordinates distanceBetweenPoints headingBetweenPoints locationWithOffset pointIsInMultiPolygon tileBounds unionOfCoordinateBounds

Constructors

constructor

new MapUtil(): MapUtil
Returns MapUtil

Methods

`Static` angleAndDirectionBetweenLocations

angleAndDirectionBetweenLocations(locA, locB, locC): Map<string, number>
Parameters
- locA: LatLng
- locB: LatLng
- locC: LatLng
Returns Map<string, number>

`Static` angleAndDirectionBetweenWaypoints

angleAndDirectionBetweenWaypoints(wpA, wpB, wpC): Map<string, number>
Parameters
- wpA: Waypoint
- wpB: Waypoint
- wpC: Waypoint
Returns Map<string, number>

`Static` averageOfCoordinates

averageOfCoordinates(coordinates): {
latitude: number;
longitude: number;
}
Averages the location for a list of coordinates
Parameters
- coordinates: LatLng[][]
  
  the list of coordinates
Returns {
latitude: number;
longitude: number;
}
the average point
- latitude: number
- longitude: number
Since
2.0.0

`Static` distanceBetweenPoints

distanceBetweenPoints(pt1, pt2): number
Calculates the distance between two LatLng coordinates.
Parameters
- pt1: LatLng
  
  First coordinate
- pt2: LatLng
  
  Second coordinate
Returns number
The distance in METERS.

`Static` headingBetweenPoints

headingBetweenPoints(p1, p2): number
Calculates the heading (bearing) between two coordinates
Parameters
- p1: LatLng
  
  First coordinate
- p2: LatLng
  
  Second coordinate
Returns number
the heading in DEGREES

`Static` locationWithOffset

locationWithOffset(source, bearing, distance): {
latitude: number;
longitude: number;
}
Calculates offset location given source location, heading (bearing), and distance.
Parameters
- source: LatLng
  
  the original coordinate
- bearing: number
  
  the bearing in DEGREES
- distance: number
  
  the offset distance in METERS
Returns {
latitude: number;
longitude: number;
}
the new location
- latitude: number
- longitude: number

`Static` pointIsInMultiPolygon

pointIsInMultiPolygon(vertices, point): boolean
Parameters
- vertices: LatLng[][]
- point: LatLng
Returns boolean

Since
1.3.2

`Static` tileBounds

tileBounds(x, y, zoom): LatLngBounds
Calculates the tile bounds on a mercator projection given an x, y, and zoom.
Parameters
- x: number
  
  X coordinate on a mercator projection.
- y: number
  
  Y coordinate on a mercator projection.
- zoom: number
  
  Zoom of the map.
Returns LatLngBounds
a LatLngBounds containing the tile coordinates

`Static` unionOfCoordinateBounds

unionOfCoordinateBounds(bounds): LatLngBounds
Combine multiple coordinate bounds into a single one
Parameters
- bounds: LatLngBounds[]
  
  a list of bounds to merge
Returns LatLngBounds
the merged bounds

Since
2.0.0

Generated using TypeDoc