Class Polygon

The Polygon class provides some simple geometric analysis tools:

Haversine distance
Add meters to a (lat, lng)
Polygon self-intersection check

Hierarchy

Polygon

Index

Constructors

Methods

addMeters distance isIntersect isValid toRadians

Constructors

constructor

new Polygon(): Polygon
Returns Polygon

Methods

`Static` addMeters

addMeters(point: IPoint, dx: number, dy: number): IPoint
Given a point (lng, lat), add (dx, dy) meters to its location. Negative values are subtracted.

Returns
Returns new point.
Parameters
- point: IPoint
  
  Source point.
- dx: number
  
  Longitude meters to add.
- dy: number
  
  Latitude meters to add.
Returns IPoint
- Defined in src/functions/Polygon.ts:54

`Static` distance

distance(point1: IPoint, point2: IPoint): number
Calculates the distance between two points in meters using the Haversine formula.

Returns
Distance between point 1 and point 2 in meters.

Example
```
const dist = Polygon.distance({ lng: 0, lat: 0 }, { lng: 1, lat: 0 });
```
Parameters
- point1: IPoint
  
  Source point.
- point2: IPoint
  
  Destination point.
Returns number
- Defined in src/functions/Polygon.ts:34

`Static` isIntersect

isIntersect(p1: IPoint, p2: IPoint, p3: IPoint, p4: IPoint): boolean
Does the line (p1,p2) intersect with line (p3,p4)?

Returns
true if the lines intersect, false if the lines do not intersect.
Parameters
- p1: IPoint
- p2: IPoint
- p3: IPoint
- p4: IPoint
Returns boolean
- Defined in src/functions/Polygon.ts:82

`Static` isValid

isValid(points: IPoint[]): boolean
Is the polygon specified by the list of points valid, i.e it does not self-intersect?

Returns
true if the polygon is valid (does not self-intersect), false if the polygon is invalid (has self-intersections).
Parameters
- points: IPoint[]
  
  Polygon points. Do not duplicate the last point.
Returns boolean
- Defined in src/functions/Polygon.ts:94

`Static` toRadians

toRadians(degrees: number): number
Convert angle degrees to radians.

Returns
Radians
Parameters
- degrees: number
  
  Degrees value
Returns number
- Defined in src/functions/Polygon.ts:18

Generated using TypeDoc