Class GeometryEnvelope

Geometry envelope

Hierarchy

GeometryEnvelope

Index

Constructors

constructor

Accessors

Constructors

constructor

new GeometryEnvelope(): GeometryEnvelope
new GeometryEnvelope(envelope: GeometryEnvelope): GeometryEnvelope
new GeometryEnvelope(hasZ: boolean, hasM: boolean): GeometryEnvelope
new GeometryEnvelope(minX: number, minY: number, maxX: number, maxY: number): GeometryEnvelope
new GeometryEnvelope(minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number): GeometryEnvelope
new GeometryEnvelope(minX: number, minY: number, minZ: number, minM: number, maxX: number, maxY: number, maxZ: number, maxM: number): GeometryEnvelope

- Defined in lib/GeometryEnvelope.ts:55
Constructor Constructor

Returns GeometryEnvelope
- Defined in lib/GeometryEnvelope.ts:57
Constructor Constructor

Parameters
- envelope: GeometryEnvelope
Returns GeometryEnvelope
- Defined in lib/GeometryEnvelope.ts:58
Constructor Constructor

Parameters
- hasZ: boolean
- hasM: boolean
Returns GeometryEnvelope
- Defined in lib/GeometryEnvelope.ts:59
Constructor Constructor

Parameters
- minX: number
- minY: number
- maxX: number
- maxY: number
Returns GeometryEnvelope
- Defined in lib/GeometryEnvelope.ts:60
Constructor Constructor

Parameters
- minX: number
- minY: number
- minZ: number
- maxX: number
- maxY: number
- maxZ: number
Returns GeometryEnvelope
- Defined in lib/GeometryEnvelope.ts:61
Constructor Constructor

Parameters
- minX: number
- minY: number
- minZ: number
- minM: number
- maxX: number
- maxY: number
- maxZ: number
- maxM: number
Returns GeometryEnvelope

Accessors

centroid

get centroid(): Point

- Defined in lib/GeometryEnvelope.ts:437
Get the envelope centroid point

Returns Point

centroid point

hasM

get hasM(): boolean
set hasM(hasM: boolean): void

- Defined in lib/GeometryEnvelope.ts:240
Has m coordinates

Returns boolean

true if has m coordinates
- Defined in lib/GeometryEnvelope.ts:248
Set has m coordinates

Parameters
- hasM: boolean
  
  has m
Returns void

true if has m coordinates

hasZ

get hasZ(): boolean
set hasZ(hasZ: boolean): void

- Defined in lib/GeometryEnvelope.ts:192
True if has Z coordinates

Returns boolean

has z
- Defined in lib/GeometryEnvelope.ts:200
Set has z coordinates

Parameters
- hasZ: boolean
  
  has z
Returns void

has z

mRange

get mRange(): number

- Defined in lib/GeometryEnvelope.ts:316
Get the m range

Returns number

m range

maxM

get maxM(): number
set maxM(maxM: number): void

- Defined in lib/GeometryEnvelope.ts:272
Get max m

Returns number

max m
- Defined in lib/GeometryEnvelope.ts:280
Set max m

Parameters
- maxM: number
  
  max m
Returns void

max m

maxX

get maxX(): number
set maxX(maxX: number): void

- Defined in lib/GeometryEnvelope.ts:144
Get max x

Returns number

max x
- Defined in lib/GeometryEnvelope.ts:152
Set max x

Parameters
- maxX: number
  
  max x
Returns void

max x

maxY

get maxY(): number
set maxY(maxY: number): void

- Defined in lib/GeometryEnvelope.ts:176
Get max y

Returns number

max y
- Defined in lib/GeometryEnvelope.ts:184
Set max y

Parameters
- maxY: number
  
  max y
Returns void

max y

maxZ

get maxZ(): number
set maxZ(maxZ: number): void

- Defined in lib/GeometryEnvelope.ts:224
Get max z

Returns number

max z
- Defined in lib/GeometryEnvelope.ts:232
Set max z

Parameters
- maxZ: number
  
  max z
Returns void

max z

minM

get minM(): number
set minM(minM: number): void

- Defined in lib/GeometryEnvelope.ts:256
Get min m

Returns number

min m
- Defined in lib/GeometryEnvelope.ts:264
Set min m

Parameters
- minM: number
  
  min m
Returns void

min m

minX

get minX(): number
set minX(minX: number): void

- Defined in lib/GeometryEnvelope.ts:128
Get min x

Returns number

min x
- Defined in lib/GeometryEnvelope.ts:136
Set min x

Parameters
- minX: number
  
  min x
Returns void

min x

minY

get minY(): number
set minY(minY: number): void

- Defined in lib/GeometryEnvelope.ts:160
Get min y

Returns number

min y
- Defined in lib/GeometryEnvelope.ts:168
Set min y

Parameters
- minY: number
  
  min y
Returns void

min y

minZ

get minZ(): number
set minZ(minZ: number): void

- Defined in lib/GeometryEnvelope.ts:208
Get min z

Returns number

min z
- Defined in lib/GeometryEnvelope.ts:216
Set min z

Parameters
- minZ: number
  
  min z
Returns void

min z

xRange

get xRange(): number

- Defined in lib/GeometryEnvelope.ts:288
Get the x range

Returns number

x range

yRange

get yRange(): number

- Defined in lib/GeometryEnvelope.ts:296
Get the y range

Returns number

y range

zRange

get zRange(): number

- Defined in lib/GeometryEnvelope.ts:304
Get the z range

Returns number

z range

Methods

buildGeometry

buildGeometry(): Geometry

- Defined in lib/GeometryEnvelope.ts:589
Build a geometry representation of the geometry envelope

Returns Geometry

geometry, polygon or point

contains

contains(envelope: GeometryEnvelope): boolean

- Defined in lib/GeometryEnvelope.ts:564
Determine if inclusively contains the provided envelope

Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
Returns boolean

true if contains

containsCoords

containsCoords(x: number, y: number): boolean

- Defined in lib/GeometryEnvelope.ts:538
Determine if contains the coordinate

since

1.1.1

Parameters
- x: number
```
       x value
```
- y: number
```
       y value
```
Returns boolean

true if contains

containsCoordsWithEpsilon

containsCoordsWithEpsilon(x: number, y: number, epsilon: number): boolean

- Defined in lib/GeometryEnvelope.ts:554
Determine if contains the coordinate

since

1.1.1

Parameters
- x: number
```
       x value
```
- y: number
```
       y value
```
- epsilon: number
```
       epsilon equality tolerance
```
Returns boolean

true if contains

containsPoint

containsPoint(point: Point): boolean

- Defined in lib/GeometryEnvelope.ts:510
Determine if contains the point

since

1.1.1

Parameters
- point: Point
```
       point
```
Returns boolean

true if contains

containsPointWithEpsilon

containsPointWithEpsilon(point: Point, epsilon: number): boolean

- Defined in lib/GeometryEnvelope.ts:524
Determine if contains the point

since

1.1.1

Parameters
- point: Point
```
       point
```
- epsilon: number
```
       epsilon equality tolerance
```
Returns boolean

true if contains

containsWithEpsilon

containsWithEpsilon(envelope: GeometryEnvelope, epsilon: number): boolean

- Defined in lib/GeometryEnvelope.ts:578
Determine if inclusively contains the provided envelope

since

1.1.1

Parameters
- envelope: GeometryEnvelope
```
       geometry envelope
```
- epsilon: number
```
       epsilon equality tolerance
```
Returns boolean

true if contains

copy

copy(): GeometryEnvelope

- Defined in lib/GeometryEnvelope.ts:610
Copy the geometry envelope

Returns GeometryEnvelope

geometry envelope copy

equals

equals(obj: GeometryEnvelope): boolean

- Defined in lib/GeometryEnvelope.ts:617
{@inheritDoc}

Parameters
- obj: GeometryEnvelope
Returns boolean

getBottom

getBottom(): Line

- Defined in lib/GeometryEnvelope.ts:389
Get the bottom line

since

1.1.1

Returns Line

bottom line

getBottomLeft

getBottomLeft(): Point

- Defined in lib/GeometryEnvelope.ts:349
Get the bottom left point

since

1.1.1

Returns Point

bottom left point

getBottomRight

getBottomRight(): Point

- Defined in lib/GeometryEnvelope.ts:359
Get the bottom right point

since

1.1.1

Returns Point

bottom right point

getLeft

getLeft(): Line

- Defined in lib/GeometryEnvelope.ts:379
Get the left line

since

1.1.1

Returns Line

left line

getMidX

getMidX(): number

- Defined in lib/GeometryEnvelope.ts:419
Get the envelope mid x

since

1.0.3

Returns number

mid x

getMidY

getMidY(): number

- Defined in lib/GeometryEnvelope.ts:429
Get the envelope mid y

since

1.0.3

Returns number

mid y

getRight

getRight(): Line

- Defined in lib/GeometryEnvelope.ts:399
Get the right line

since

1.1.1

Returns Line

right line

getTop

getTop(): Line

- Defined in lib/GeometryEnvelope.ts:409
Get the top line

since

1.1.1

Returns Line

top line

getTopLeft

getTopLeft(): Point

- Defined in lib/GeometryEnvelope.ts:339
Get the top left point

since

1.1.1

Returns Point

top left point

getTopRight

getTopRight(): Point

- Defined in lib/GeometryEnvelope.ts:369
Get the top right point

since

1.1.1

Returns Point

top right point

intersects

intersects(envelope: GeometryEnvelope, allowEmpty: boolean): boolean

- Defined in lib/GeometryEnvelope.ts:457
Determine if intersects with the provided envelope

Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- allowEmpty: boolean
  
  allow empty ranges when determining intersection
Returns boolean

true if intersects

is3D

is3D(): boolean

- Defined in lib/GeometryEnvelope.ts:112
True if has Z coordinates

see

#hasZ()

Returns boolean

has z

isEmpty

isEmpty(): boolean

- Defined in lib/GeometryEnvelope.ts:447
Determine if the envelope is empty

since

1.1.1

Returns boolean

true if empty

isMeasured

isMeasured(): boolean

- Defined in lib/GeometryEnvelope.ts:120
True if has M measurements

see

#hasM()

Returns boolean

has m

isPoint

isPoint(): boolean

- Defined in lib/GeometryEnvelope.ts:329
Determine if the envelope is of a single point

since

2.0.5

Returns boolean

true if a single point bounds

overlap

overlap(envelope: GeometryEnvelope, allowEmpty?: boolean): GeometryEnvelope

- Defined in lib/GeometryEnvelope.ts:467
Get the overlapping geometry envelope with the provided envelope

Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
- Default value allowEmpty: boolean = false
  
  allow empty ranges when determining intersection
Returns GeometryEnvelope

geometry envelope

union

union(envelope: GeometryEnvelope): GeometryEnvelope

- Defined in lib/GeometryEnvelope.ts:487
Get the union geometry envelope combined with the provided envelope

Parameters
- envelope: GeometryEnvelope
  
  geometry envelope
Returns GeometryEnvelope

geometry envelope

Generated using TypeDoc