Extent

Premium

Represents a geographic region defined by two extreme locations (North West and South East).

Name	Type	Default	Description
nw	Location		The North West extreme location.
se	Location		The South East extreme location.

Constructors

Extent

(nw: number[] | Location | [number, number], se: number[] | Location | [number, number])

Creates a new Extent.

Parameters

nw

number[] | Location | [number, number]

The North West extreme location.

se

number[] | Location | [number, number]

The South East extreme location.

Methods

center
Returns the center of the extent.
Returns Location The extent center location.

contains
Tests if a location is contained within the extent.
Parameters location Location The location to test for.
Returns boolean true if the extent contains the location, false otherwise.

containsAny
Tests if any of the locations is contained within the extent.
Parameters locations Location[] An array of locations to test for.
Returns boolean true if the extent contains any of the locations, false otherwise.

edges
Returns the four extreme locations of the extent.
Returns { ne: Location; nw: Location; se: Location; sw: Location; } An object with nw, ne, se and sw locations.

include
Grows the extent, if required, to contain the specified location.
Parameters location Location The location to include in the extent.

includeAll
Grows the extent, if required, to contain all specified locations.
Parameters locations any The locations to include in the extent.

overlaps
Tests if the given extent overlaps with this instance.
Parameters extent Extent The extent to test with.
Returns boolean true if the extents overlap, false otherwise.

toArray
Returns the four extreme locations of the extent as an array.
Returns [Location, Location, Location, Location] An array with [NW, NE, SE, SW] locations.