Class GeoBox

GeoBox is used to represent a bounding box in geo coordinates.

Hierarchy

GeoBox

Implements

GeoBoxExtentLike

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GeoBox(southWest: GeoCoordinates, northEast: GeoCoordinates): GeoBox

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:43
Constructs a new GeoBox with the given geo coordinates.

Parameters
- southWest: GeoCoordinates
  
  The south west position in geo coordinates.
- northEast: GeoCoordinates
  
  The north east position in geo coordinates.
Returns GeoBox

Properties

Readonly northEast

northEast: GeoCoordinates

The north east position in geo coordinates.

Readonly southWest

southWest: GeoCoordinates

The south west position in geo coordinates.

Accessors

altitudeSpan

get altitudeSpan(): number | undefined

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:153
Returns number | undefined

center

get center(): GeoCoordinates

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:108
Returns the center of this GeoBox.

Returns GeoCoordinates

east

get east(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:101
Returns the east longitude in degrees of this GeoBox.

Returns number

latitudeSpan

get latitudeSpan(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:149
Returns the latitude span in degrees.

Returns number

latitudeSpanInDegrees

get latitudeSpanInDegrees(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:177
Returns the latitude span in degrees.

deprecated

Use latitudeSpan instead.

Returns number

latitudeSpanInRadians

get latitudeSpanInRadians(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:135
Returns the latitude span in radians.

Returns number

longitudeSpan

get longitudeSpan(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:163
Returns the longitude span in degrees.

Returns number

longitudeSpanInDegrees

get longitudeSpanInDegrees(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:185
Returns the longitude span in degrees.

deprecated

Use longitudeSpan instead.

Returns number

longitudeSpanInRadians

get longitudeSpanInRadians(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:142
Returns the longitude span in radians.

Returns number

maxAltitude

get maxAltitude(): number | undefined

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:70
Returns the maximum altitude or undefined.

Returns number | undefined

minAltitude

get minAltitude(): number | undefined

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:60
Returns the minimum altitude or undefined.

Returns number | undefined

north

get north(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:87
Returns the north altitude in degrees of this GeoBox.

Returns number

south

get south(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:80
Returns the south latitude in degrees of this GeoBox.

Returns number

west

get west(): number

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:94
Returns the west longitude in degrees of this GeoBox.

Returns number

Methods

clone

clone(): GeoBox

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:221
Clones this GeoBox instance.

Returns GeoBox

contains

contains(point: GeoCoordinates): boolean

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:194
Returns true if the given geo coordinates are contained in this GeoBox.

Parameters
- point: GeoCoordinates
  
  The geo coordinates.
Returns boolean

growToContain

growToContain(point: GeoCoordinatesLike): void

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:230
Update the bounding box by considering a given point.

Parameters
- point: GeoCoordinatesLike
  
  The point that may expand the bounding box.
Returns void

Static fromCenterAndExtents

fromCenterAndExtents(center: GeoCoordinates, extent: GeoBoxExtentLike): GeoBox

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:32
Returns a GeoBox with the given center and dimensions.

Parameters
- center: GeoCoordinates
  
  The center position of geo box.
- extent: GeoBoxExtentLike
  
  Box latitude and logitude span
Returns GeoBox

Static fromCoordinates

fromCoordinates(southWest: GeoCoordinates, northEast: GeoCoordinates): GeoBox

- Defined in @here/harp-geoutils/lib/coordinates/GeoBox.ts:22
Returns a GeoBox with the given geo coordinates.

Parameters
- southWest: GeoCoordinates
  
  The south west position in geo coordinates.
- northEast: GeoCoordinates
  
  The north east position in geo coordinates.
Returns GeoBox

Generated using TypeDoc